Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

обновить-действие-по-смягчению

Описание

Обновляет определение указанного действия по смягчению последствий.

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

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

Синтаксис

  update-mitigation-action
--action-name <value>
[--role-arn <value>]
[--action-params <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]

Параметры

--action-name (строка)

Дружественное имя для действия по смягчению последствий. Вы не можете изменить имя, используя UpdateMitigationAction . Вместо этого, вы должны удалить и воссоздать действие по смягчению последствий с новым именем.

--role-arn (строка)

ARN роли IAM, используемой для применения действия по смягчению последствий.

--action-params (структура)

Определяет тип действия и параметры для этого действия.

updateDeviceCertificateParams -> (структура)

Параметры для определения действия по смягчению последствий, которое изменяет состояние сертификата устройства на неактивное.

action -> (строка)

Действие, которое вы хотите применить к сертификату устройства. Единственное поддерживаемое значение — DEACTIVATE .

updateCACertificateParams -> (структура)

Параметры для определения действия по смягчению последствий, которое изменяет состояние сертификата CA на неактивное.

action -> (строка)

Действие, которое вы хотите применить к сертификату CA. Единственное поддерживаемое значение — DEACTIVATE .

addThingsToThingGroupParams -> (структура)

Параметры для определения действия по смягчению последствий, которое перемещает устройства, связанные с сертификатом, в одну или несколько указанных групп устройств, обычно для карантина.

thingGroupNames -> (список)

Список групп, в которые вы хотите добавить вещи, которые вызвали действие по смягчению последствий. Вы можете добавить вещь к максимуму 10 групп, но не можете добавить вещь более чем к одной группе в одной иерархии.

(строка)

overrideDynamicGroups -> (булево)

Указывает, может ли это действие по смягчению последствий перемещать вещи, которые его вызвали, даже если они являются частью одной или нескольких динамических групп устройств.

replaceDefaultPolicyVersionParams -> (структура)

Параметры для определения действия по смягчению последствий, которое добавляет пустую политику для ограничения разрешений.

templateName -> (строка)

Имя шаблона, который будет применён. Единственное поддерживаемое значение — BLANK_POLICY .

enableIoTLoggingParams -> (структура)

Параметры для определения действия по смягчению последствий, которое включает ведение журналов Amazon Web Services IoT Core на указанном уровне детализации.

roleArnForLogging -> (строка)

Amazon Resource Name (ARN) роли IAM, используемой для ведения журналов.

logLevel -> (строка)

Указывает тип информации, которая должна быть залогирована.

publishFindingToSnsParams -> (структура)

Параметры для определения действия по смягчению последствий, которое публикует результаты в Amazon Simple Notification Service (Amazon SNS). Вы можете реализовать свои собственные пользовательские действия в ответ на сообщения Amazon SNS.

topicArn -> (строка)

ARN темы, в которую вы хотите опубликовать результаты.

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

updateDeviceCertificateParams={action=string},updateCACertificateParams={action=string},addThingsToThingGroupParams={thingGroupNames=[string,string],overrideDynamicGroups=boolean},replaceDefaultPolicyVersionParams={templateName=string},enableIoTLoggingParams={roleArnForLogging=string,logLevel=string},publishFindingToSnsParams={topicArn=string}

Синтаксис JSON:

{
  "updateDeviceCertificateParams": {
    "action": "DEACTIVATE"
  },
  "updateCACertificateParams": {
    "action": "DEACTIVATE"
  },
  "addThingsToThingGroupParams": {
    "thingGroupNames": ["string", ...],
    "overrideDynamicGroups": true|false
  },
  "replaceDefaultPolicyVersionParams": {
    "templateName": "BLANK_POLICY"
  },
  "enableIoTLoggingParams": {
    "roleArnForLogging": "string",
    "logLevel": "DEBUG"|"INFO"|"ERROR"|"WARN"|"DISABLED"
  },
  "publishFindingToSnsParams": {
    "topicArn": "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 (булево)

Отключить пейджер cli для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров входных данных CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

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

Для обновления действия по смягчению последствий

Следующий update-mitigation-action пример обновляет указанное действие по смягчению последствий с именем AddThingsToQuarantineGroupAction, изменяет имя группы устройств и устанавливает overrideDynamicGroups на false. Вы можете проверить свои изменения, используя команду describe-mitigation-action.

aws iot update-mitigation-action \
    --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}"

Вывод:

{
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
    "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa"
}

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

Вывод

actionArn -> (строка)

ARN нового действия по смягчению последствий.

actionId -> (строка)

Уникальный идентификатор действия по смягчению последствий.

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

Spec-Zone.ru

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