Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

создать-планируемый-аудит

Описание

Создаёт запланированный аудит, который выполняется с указанным интервалом.

Требуется разрешение на доступ к действию CreateScheduledAudit.

См. также: Документация API AWS

Синтаксис

  create-scheduled-audit
--frequency <value>
[--day-of-month <value>]
[--day-of-week <value>]
--target-check-names <value>
--scheduled-audit-name <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--frequency (строка)

Частота проведения запланированного аудита, либо DAILY , WEEKLY , BIWEEKLY или MONTHLY . Время начала каждого аудита определяется системой.

Возможные значения:

  • DAILY
  • WEEKLY
  • BIWEEKLY
  • MONTHLY

--day-of-month (строка)

День месяца, в который проводится запланированный аудит. Может принимать значения от “1” до “31” или “LAST”. Это поле обязательно, если параметр “frequency” установлен на MONTHLY . Если указаны дни с 29 по 31, а в месяце меньше дней, аудит выполняется в LAST день месяца.

--day-of-week (строка)

День недели, в который проводится запланированный аудит, либо SUN , MON , TUE , WED , THU , FRI или SAT . Это поле необходимо, если параметр frequency установлен на WEEKLY или BIWEEKLY .

Возможные значения:

  • SUN
  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT

--target-check-names (список)

Какие проверки проводятся во время запланированного аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая включённые, или UpdateAccountAuditConfiguration, чтобы выбрать какие проверки включить.)

(строка)

Имя проверки аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая включённые, или UpdateAccountAuditConfiguration, чтобы выбрать какие проверки включить.)

Синтаксис:

"string" "string" ...

--scheduled-audit-name (строка)

Имя, которое вы хотите дать запланированному аудиту. (Макс. 128 символов)

--tags (список)

Метаданные, которые могут быть использованы для управления запланированным аудитом.

(структура)

Набор пар ключ/значение, используемых для управления ресурсом.

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

Значение тега.

Сокращённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON строки. JSON строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределяют значения из JSON. Невозможно передать произвольные двоичные значения, используя JSON-значение в качестве строки, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример JSON ввода, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выводит пример YAML ввода, который может быть использован с --cli-input-yaml. Если предоставлено значение output, валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON скелет не стабилен между версиями AWS CLI и нет гарантии обратной совместимости в сгенерированном JSON скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS сервисами. Для каждого SSL соединения AWS CLI будет проверять SSL сертификаты. Этот параметр переопределяет поведение проверки SSL сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл с пакетом сертификатов CA для проверки SSL сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для бинарных блоков. Формат по умолчанию base64. Формат base64 ожидает, что бинарные блоки будут предоставлены как base64 закодированная строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1 и бинарные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое сопоставляется с бинарным блоком fileb:// всегда будет обрабатываться как бинарный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страницы AWS CLI.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, вы должны иметь установленный и настроенный AWS CLI. Подробнее см. руководство «Начало работы» в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования Unix-подобных терминалов. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Используйте кавычки со строками в Руководстве пользователя AWS CLI.

Для создания запланированного аудита

Следующий create-scheduled-audit пример создаёт запланированный аудит, который выполняется еженедельно по средам, для проверки истечения срока действия сертификатов CA или сертификатов устройств.

aws iot create-scheduled-audit \
    --scheduled-audit-name WednesdayCertCheck \
    --frequency WEEKLY \
    --day-of-week WED \
    --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK

Вывод:

{
    "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck"
}

Дополнительную информацию см. в разделе Команды аудита в Руководстве разработчика AWS IoT.

Вывод

scheduledAuditArn -> (строка)

ARN запланированного аудита.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API