Spec-Zone.ru › AWS CLI v2

[ aws . ssm-incidents ]

получить-план-реагирования

Описание

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

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

Синтаксис

  get-response-plan
--arn <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]

Параметры

--arn (строка)

Amazon Resource Name (ARN) плана реагирования.

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

Для получения подробной информации о плане реагирования

Следующий command-name пример получает подробную информацию о заданном плане реагирования в вашей учетной записи AWS.

aws ssm-incidents get-response-plan \
    --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan"

Вывод:

{
    "actions": [
        {
            "ssmAutomation": {
                "documentName": "AWSIncidents-CriticalIncidentRunbookTemplate",
                "documentVersion": "$DEFAULT",
                "roleArn": "arn:aws:iam::111122223333:role/aws-service-role/ssm-incidents.amazonaws.com/AWSServiceRoleForIncidentManager",
                "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"
            }
        }
    ],
    "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan",
    "chatChannel": {
        "chatbotSns": [
            "arn:aws:sns:us-east-1:111122223333:Standard_User"
        ]
    },
    "displayName": "Example response plan",
    "engagements": [
        "arn:aws:ssm-contacts:us-east-1:111122223333:contact/example"
    ],
    "incidentTemplate": {
        "impact": 5,
        "title": "Example-Incident"
    },
    "name": "Example-Response-Plan"
}

Для получения дополнительной информации см. Подготовка к инцидентам в Руководстве пользователя Incident Manager.

Вывод

actions -> (список)

Действия, которые выполняет этот план реагирования в начале инцидента.

(структура помеченного объединения)

Действие, которое начинается в начале инцидента. План реагирования определяет это действие.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: ssmAutomation.

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

Документ автоматизации Systems Manager, который нужно запустить в качестве руководства к действию в начале инцидента.

documentName -> (строка)

Название документа автоматизации.

documentVersion -> (строка)

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

dynamicParameters -> (карта)

Пара ключ-значение для разрешения значений динамических параметров при обработке руководства к действию автоматизации Systems Manager.

key -> (строка)

value -> (структура помеченного объединения)

Значение динамического параметра SSM.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: variable.

variable -> (строка)

Динамические параметры переменных. Значение параметра определяется при создании инцидента.

parameters -> (карта)

Параметры ключ-значение, используемые при выполнении документа автоматизации.

key -> (строка)

value -> (список)

(строка)

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли, которую документ автоматизации примет при выполнении команд.

targetAccount -> (строка)

Аккаунт, в котором будет выполняться документ автоматизации. Он может находиться как в учетной записи управления, так и в прикладной учетной записи.

arn -> (строка)

ARN плана реагирования.

chatChannel -> (структура помеченного объединения)

Канал чата чатбота, используемый для взаимодействия во время инцидента.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: chatbotSns, empty.

chatbotSns -> (список)

Целевые адреса Amazon SNS, которые чатбот использует для уведомления канала чата о событиях в инциденте. Вы также можете вносить изменения в инцидент через канал чата, используя темы Amazon SNS.

(строка)

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

Используется для удаления канала чата из записи инцидента или плана реагирования.

displayName -> (строка)

Полное имя плана реагирования. Может содержать пробелы.

engagements -> (список)

Идентификатор ресурса Amazon (ARN) контактов и планов эскалации, которые план реагирования вовлекает во время инцидента.

(строка)

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

Детали, используемые для создания инцидента при использовании этого плана реагирования.

dedupeString -> (строка)

Строка, которую Incident Manager использует для предотвращения создания нескольких инцидентов с одним корнем причины в одной учетной записи.

Строка дедупликации — это термин или фраза, используемая системой для проверки дублирования инцидентов. Если вы укажете строку дедупликации, Incident Manager при создании инцидента ищет открытые инциденты, содержащие эту строку в поле dedupeString. Если дубликат обнаружен, Incident Manager объединяет новый инцидент с существующим.

Примечание

По умолчанию Incident Manager автоматически объединяет несколько инцидентов, созданных одним и тем же уведомлением Amazon CloudWatch или событием Amazon EventBridge. Вам не нужно вводить свою строку дедупликации для предотвращения дублирования для этих типов ресурсов.

impact -> (целое число)

Влияние инцидента на ваших клиентов и приложения.

Поддерживаемые коды влияния
  • 1 - Критический
  • 2 - Высокий
  • 3 - Средний
  • 4 - Низкий
  • 5 - Без влияния

incidentTags -> (карта)

Теги, которые необходимо назначить шаблону. При вызове действия API StartIncident Incident Manager назначает теги, указанные в шаблоне, к инциденту.

key -> (строка)

value -> (строка)

notificationTargets -> (список)

Целевые адреса Amazon SNS, которые уведомляются при внесении изменений в инцидент.

(структура помеченного объединения)

Целевые адреса SNS, которые уведомляются при внесении изменений в инцидент.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: snsTopicArn.

snsTopicArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы SNS.

summary -> (строка)

Резюме инцидента. Резюме — краткое описание произошедшего, текущей ситуации и контекста.

title -> (строка)

Заголовок инцидента.

integrations -> (список)

Информация о сторонних службах, интегрированных в план реагирования Incident Manager.

(структура помеченного объединения)

Информация о сторонних службах, интегрированных в план реагирования.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: pagerDutyConfiguration.

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

Информация о службе PagerDuty, где план реагирования создает инцидент.

name -> (строка)

Имя конфигурации PagerDuty.

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

Детали о службе PagerDuty, связанной с конфигурацией.

serviceId -> (строка)

Идентификатор службы PagerDuty, которую план реагирования связывает с инцидентом при запуске.

secretId -> (строка)

Идентификатор секрета Amazon Web Services Secrets Manager, в котором хранится ваш ключ PagerDuty (ключ REST API общего доступа или ключ REST API токена пользователя) и другие учетные данные пользователя.

name -> (строка)

Короткое имя плана реагирования. Имя не может содержать пробелы.

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

Spec-Zone.ru

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