Spec-Zone.ru › AWS CLI v2

[ aws . ssm-incidents ]

обновление связанных элементов

Описание

Добавление или удаление связанных элементов из вкладки «Связанные элементы» записи инцидента.

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

Синтаксис

  update-related-items
[--client-token <value>]
--incident-record-arn <value>
--related-items-update <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]

Параметры

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

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

--incident-record-arn (строка)

Amazon Resource Name (ARN) записи инцидента, содержащей связанные элементы, которые вы обновляете.

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

Подробности об элементе, который вы добавляете или удаляете из инцидента.

Примечание

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

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

Подробности о связанном элементе, который вы добавляете.

generatedId -> (строка)

Уникальный идентификатор RelatedItem.

Предупреждение

Не указывайте этот параметр, когда вы добавляете RelatedItem с помощью действия API UpdateRelatedItems.

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

Подробности о связанном элементе.

type -> (строка)

Тип связанного элемента.

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

Подробности о связанном элементе.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: arn, metricDefinition, pagerDutyIncidentDetail, url.

arn -> (строка)

Amazon Resource Name (ARN) связанного элемента, если связанный элемент является Amazon-ресурсом.

metricDefinition -> (строка)

Определение метрики, если связанный элемент — метрика в Amazon CloudWatch.

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

Подробности об инциденте, связанном с инцидентом PagerDuty.

autoResolve -> (булево)

Указывает, следует ли разрешать инцидент PagerDuty при разрешении связанного инцидента Incident Manager.

id -> (строка)

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

secretId -> (строка)

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

url -> (строка)

URL, если связанный элемент — ресурс, не являющийся Amazon Web Services ресурсом.

title -> (строка)

Название связанного элемента.

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

Подробности о связанном элементе, который вы удаляете.

type -> (строка)

Тип связанного элемента.

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

Подробности о связанном элементе.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: arn, metricDefinition, pagerDutyIncidentDetail, url.

arn -> (строка)

Amazon Resource Name (ARN) связанного элемента, если связанный элемент является Amazon-ресурсом.

metricDefinition -> (строка)

Определение метрики, если связанный элемент — метрика в Amazon CloudWatch.

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

Подробности об инциденте, связанном с инцидентом PagerDuty.

autoResolve -> (булево)

Указывает, следует ли разрешать инцидент PagerDuty при разрешении связанного инцидента Incident Manager.

id -> (строка)

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

secretId -> (строка)

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

url -> (строка)

URL, если связанный элемент — ресурс, не являющийся Amazon Web Services ресурсом.

Синтаксис JSON:

{
  "itemToAdd": {
    "generatedId": "string",
    "identifier": {
      "type": "ANALYSIS"|"INCIDENT"|"METRIC"|"PARENT"|"ATTACHMENT"|"OTHER"|"AUTOMATION"|"INVOLVED_RESOURCE"|"TASK",
      "value": {
        "arn": "string",
        "metricDefinition": "string",
        "pagerDutyIncidentDetail": {
          "autoResolve": true|false,
          "id": "string",
          "secretId": "string"
        },
        "url": "string"
      }
    },
    "title": "string"
  },
  "itemToRemove": {
    "type": "ANALYSIS"|"INCIDENT"|"METRIC"|"PARENT"|"ATTACHMENT"|"OTHER"|"AUTOMATION"|"INVOLVED_RESOURCE"|"TASK",
    "value": {
      "arn": "string",
      "metricDefinition": "string",
      "pagerDutyIncidentDetail": {
        "autoResolve": true|false,
        "id": "string",
        "secretId": "string"
      },
      "url": "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
  • text
  • таблица
  • 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-related-item удаляет связанный элемент из указанной записи инцидента.

aws ssm-incidents update-related-items \
    --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \
    --related-items-update '{"itemToRemove": {"type": "OTHER", "value": {"url": "https://console.aws.amazon.com/systems-manager/opsitems/oi-8ef82158e190/workbench?region=us-east-1"}}}'

Эта команда не генерирует вывод.

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

Вывод

Нет

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

Spec-Zone.ru

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