Spec-Zone.ru › AWS CLI v2

[ aws . ssm-incidents ]

Обновить план реагирования

Описание

Обновляет указанный план реагирования.

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

Синтаксис

  update-response-plan
[--actions <value>]
--arn <value>
[--chat-channel <value>]
[--client-token <value>]
[--display-name <value>]
[--engagements <value>]
[--incident-template-dedupe-string <value>]
[--incident-template-impact <value>]
[--incident-template-notification-targets <value>]
[--incident-template-summary <value>]
[--incident-template-tags <value>]
[--incident-template-title <value>]
[--integrations <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]

Параметры

--actions (список)

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

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

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

Примечание

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

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

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

documentName -> (строка)

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

documentVersion -> (строка)

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

dynamicParameters -> (массив)

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

key -> (строка)

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

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

Примечание

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

variable -> (строка)

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

parameters -> (массив)

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

key -> (строка)

value -> (список)

(строка)

roleArn -> (строка)

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

targetAccount -> (строка)

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

Синтаксис сокращенного представления:

ssmAutomation={documentName=string,documentVersion=string,dynamicParameters={KeyName1={variable=string},KeyName2={variable=string}},parameters={KeyName1=[string,string],KeyName2=[string,string]},roleArn=string,targetAccount=string} ...

Синтаксис JSON:

[
  {
    "ssmAutomation": {
      "documentName": "string",
      "documentVersion": "string",
      "dynamicParameters": {"string": {
            "variable": "INCIDENT_RECORD_ARN"|"INVOLVED_RESOURCES"
          }
        ...},
      "parameters": {"string": ["string", ...]
        ...},
      "roleArn": "string",
      "targetAccount": "RESPONSE_PLAN_OWNER_ACCOUNT"|"IMPACTED_ACCOUNT"
    }
  }
  ...
]

--arn (строка)

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

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

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

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

Примечание

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

chatbotSns -> (список)

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

(строка)

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

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

Синтаксис сокращенного представления:

chatbotSns=string,string,empty={}

Синтаксис JSON:

{
  "chatbotSns": ["string", ...],
  "empty": {

  }
}

--client-token (строка)

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

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

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

--engagements (список)

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

(строка)

Синтаксис:

"string" "string" ...

--incident-template-dedupe-string (строка)

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

--incident-template-impact (целое число)

Определяет влияние на клиентов. Указание уровня влияния переписывает уровень влияния, указанный в плане реагирования.

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

--incident-template-notification-targets (список)

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

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

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

Примечание

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

snsTopicArn -> (строка)

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

Синтаксис сокращенного представления:

snsTopicArn=string ...

Синтаксис JSON:

[
  {
    "snsTopicArn": "string"
  }
  ...
]

--incident-template-summary (строка)

Краткое описание инцидента. Обычно содержит информацию о произошедшем, текущей ситуации и следующих шагах.

--incident-template-tags (массив)

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

key -> (строка)

value -> (строка)

Синтаксис сокращенного представления:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--incident-template-title (строка)

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

--integrations (список)

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

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

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

Примечание

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

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

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

name -> (строка)

Название конфигурации PagerDuty.

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

Подробная информация о сервисе PagerDuty, связанном с конфигурацией.

serviceId -> (строка)

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

secretId -> (строка)

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

Синтаксис сокращенного представления:

pagerDutyConfiguration={name=string,pagerDutyIncidentConfiguration={serviceId=string},secretId=string} ...

Синтаксис JSON:

[
  {
    "pagerDutyConfiguration": {
      "name": "string",
      "pagerDutyIncidentConfiguration": {
        "serviceId": "string"
      },
      "secretId": "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-response-plan пример удаляет канал чата из указанного плана реагирования.

aws ssm-incidents update-response-plan \
    --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \
    --chat-channel '{"empty":{}}'

Эта команда не выводит никаких данных.

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

Вывод

Нет

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

Spec-Zone.ru

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