[ aws . ssm-contacts ]
создать-контакт
Описание
Контакты — это либо контакты, с которыми менеджер инцидентов взаимодействует во время инцидента, либо планы эскалации, используемые менеджером инцидентов для взаимодействия с контактами на разных этапах инцидента.
См. также: Документацию API AWS
Синтаксис
create-contact
--alias <value>
[--display-name <value>]
--type <value>
--plan <value>
[--tags <value>]
[--idempotency-token <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]
Параметры
--alias (строка)
--display-name (строка)
--type (строка)
Для создания плана эскалации используйте ESCALATION . Для создания контакта используйте PERSONAL .
Возможные значения:
PERSONALESCALATIONONCALL_SCHEDULE
--plan (структура)
Список этапов. Контакт имеет план взаимодействия с этапами, которые определяют каналы связи с контактом. План эскалации использует этапы, которые определяют контакты.
Stages -> (список)
Список этапов, которые план эскалации или план взаимодействия использует для взаимодействия с контактами и методами связи.
(структура)
Установленное количество времени, в течение которого план эскалации или план взаимодействия взаимодействует с указанными контактами или методами связи.
DurationInMinutes -> (целое число)
Targets -> (список)
Контакты или методы связи, с которыми взаимодействует план эскалации или план взаимодействия.
(структура)
Контакт или канал связи, с которым происходит взаимодействие.
ChannelTargetInfo -> (структура)
Информация о канале связи, с которым менеджер инцидентов взаимодействует.
ContactChannelId -> (строка)
RetryIntervalInMinutes -> (целое число)
ContactTargetInfo -> (структура)
Информация о контакте, с которым менеджер инцидентов взаимодействует.
ContactId -> (строка)
IsEssential -> (булево)
RotationIds -> (список)
Amazon Resource Names (ARN) вращающихся смен, связанных с планом.
(строка)
Синтаксис JSON:
{
"Stages": [
{
"DurationInMinutes": integer,
"Targets": [
{
"ChannelTargetInfo": {
"ContactChannelId": "string",
"RetryIntervalInMinutes": integer
},
"ContactTargetInfo": {
"ContactId": "string",
"IsEssential": true|false
}
}
...
]
}
...
],
"RotationIds": ["string", ...]
}
--tags (список)
Добавляет тег к цели. Вы можете добавлять теги только к ресурсам, созданным в первом регионе вашего набора репликации.
(структура)
Контейнер пары имя-значение.
Key -> (строка)
Value -> (строка)
Краткая запись:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--idempotency-token (строка)
--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.
Для создания контакта
Следующий create-contact пример создает контакт в вашей среде с пустым планом. План можно обновить после создания каналов связи. Используйте команду create-contact-channel с ARN вывода этой команды. После создания каналов связи для этого контакта используйте команду update-contact для обновления плана.
aws ssm-contacts create-contact \
--alias "akuam" \
--display-name "Akua Mansa" \
--type PERSONAL \
--plan '{"Stages": []}'
Вывод:
{
"ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}
Дополнительную информацию см. в разделе Контакты в Руководстве пользователя менеджера инцидентов.
Вывод
ContactArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.