[ aws . ssm-incidents ]
получить-запись-инцидента
Описание
Возвращает подробности о заданной записи инцидента.
См. также: Документацию API AWS
Синтаксис
get-incident-record
--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 (строка)
--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.
Получить запись инцидента
Следующий get-incident-record пример получает подробности о заданной записи инцидента.
aws ssm-incidents get-incident-record \
--arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308"
Вывод:
{
"incidentRecord": {
"arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308",
"automationExecutions": [],
"creationTime": "2021-05-21T18:16:57.579000+00:00",
"dedupeString": "c4bcc812-85e7-938d-2b78-17181176ee1a",
"impact": 5,
"incidentRecordSource": {
"createdBy": "arn:aws:iam::111122223333:user/draliatp",
"invokedBy": "arn:aws:iam::111122223333:user/draliatp",
"source": "aws.ssm-incidents.custom"
},
"lastModifiedBy": "arn:aws:iam::111122223333:user/draliatp",
"lastModifiedTime": "2021-05-21T18:16:59.149000+00:00",
"notificationTargets": [],
"status": "OPEN",
"title": "Example-Incident"
}
}
Дополнительную информацию см. в разделе Сведения об инцидентах в руководстве пользователя Incident Manager.
Вывод
incidentRecord -> (структура)
Подробности структуры записи инцидента.
arn -> (строка)
automationExecutions -> (список)
Сценарий или документ автоматизации, запускаемый в начале инцидента.
(структура помеченной связи)
Процесс автоматизации Systems Manager для запуска в качестве сценария в начале инцидента.
Примечание
Это структура помеченной связи. Только один из следующих ключевых элементов верхнего уровня может быть установлен:ssmExecutionArn.ssmExecutionArn -> (строка)
chatChannel -> (структура помеченной связи)
Канал чата, используемый для совместной работы во время инцидента.
Примечание
Это структура помеченной связи. Только один из следующих ключевых элементов верхнего уровня может быть установлен:chatbotSns, empty.chatbotSns -> (список)
Amazon SNS-цели, которые Chatbot использует для уведомления канала чата об обновлениях инцидента. Также можно вносить изменения в инцидент через канал чата, используя Amazon SNS-темы.
(строка)
empty -> (структура)
creationTime -> (метка времени)
dedupeString -> (строка)
impact -> (целое число)
Влияние инцидента на клиентов и приложения.
-
1- Критический -
2- Высокий -
3- Средний -
4- Низкий -
5- Без влияния
incidentRecordSource -> (структура)
Подробности о действии, которое вызвало инцидент.
createdBy -> (строка)
invokedBy -> (строка)
createdBy. Если никакой служебный принципал не принял роль, это поле останется пустым.resourceArn -> (строка)
source -> (строка)
lastModifiedBy -> (строка)
lastModifiedTime -> (метка времени)
notificationTargets -> (список)
Amazon SNS-цели, которые уведомляются при внесении изменений в инцидент.
(структура помеченной связи)
SNS-цели, которые уведомляются при внесении изменений в инцидент.
Примечание
Это структура помеченной связи. Только один из следующих ключевых элементов верхнего уровня может быть установлен:snsTopicArn.snsTopicArn -> (строка)
resolvedTime -> (метка времени)
status -> (строка)
summary -> (строка)
title -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|