Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

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

Описание

Получение информации об действии по смягчению.

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

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

Синтаксис

  describe-mitigation-action
--action-name <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 (строка)

Дружественное имя, уникально идентифицирующее действие по смягчению.

--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.

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

Следующий describe-mitigation-action пример отображает подробности о заданном действии по смягчению.

aws iot describe-mitigation-action \
    --action-name AddThingsToQuarantineGroupAction

Вывод:

{
    "actionName": "AddThingsToQuarantineGroupAction",
    "actionType": "ADD_THINGS_TO_THING_GROUP",
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction",
    "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa",
    "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole",
    "actionParams": {
        "addThingsToThingGroupParams": {
            "thingGroupNames": [
                "QuarantineGroup1"
            ],
            "overrideDynamicGroups": true
        }
    },
    "creationDate": "2019-12-10T11:09:35.999000-08:00",
    "lastModifiedDate": "2019-12-10T11:09:35.999000-08:00"
}

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

Вывод

actionName -> (строка)

Дружественное имя, уникально идентифицирующее действие по смягчению.

actionType -> (строка)

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

actionArn -> (строка)

ARN, идентифицирующий данное действие по смягчению.

actionId -> (строка)

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

roleArn -> (строка)

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

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

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

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 темы, в которую вы хотите опубликовать результаты.

creationDate -> (временная метка)

Дата и время добавления действия по смягчению в вашу учетную запись Amazon Web Services.

lastModifiedDate -> (временная метка)

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

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

Spec-Zone.ru

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