Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

create-contact-method

Описание

Создает контактный метод для отправки электронных писем или SMS-сообщений.

Контактный метод используется для получения уведомлений о ваших ресурсах Amazon Lightsail. Вы можете добавить один адрес электронной почты и один номер мобильного телефона в каждой области Amazon Web Services. Однако SMS-сообщения не поддерживаются во всех областях Amazon Web Services, а также не во всех странах/регионах. Для получения дополнительной информации см. Уведомления в Amazon Lightsail.

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

Синтаксис

  create-contact-method
--protocol <value>
--contact-endpoint <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]

Параметры

--protocol (строка)

Протокол контактного метода, например Email или SMS (сообщения).

Протокол SMS поддерживается только в следующих областях Amazon Web Services.

  • США Восточный регион (Северная Вирджиния) (us-east-1 )
  • США Западный регион (Орегон) (us-west-2 )
  • Европа (Ирландия) (eu-west-1 )
  • Азиатско-Тихоокеанский регион (Токио) (ap-northeast-1 )
  • Азиатско-Тихоокеанский регион (Сингапур) (ap-southeast-1 )
  • Азиатско-Тихоокеанский регион (Сидней) (ap-southeast-2 )

Список стран/регионов, в которые могут быть отправлены SMS-сообщения, и последние области Amazon Web Services, в которых поддерживаются SMS-сообщения, см. в разделе Поддерживаемые регионы и страны в Руководстве разработчика Amazon SNS.

Для получения дополнительной информации об уведомлениях в Amazon Lightsail, см. Уведомления в Amazon Lightsail.

Возможные значения:

  • Email
  • SMS

--contact-endpoint (строка)

Получатель контактного метода, например адрес электронной почты или номер мобильного телефона.

При указании номера мобильного телефона используйте формат E.164. E.164 — это стандарт структуры номера телефона, используемый в международной телекоммуникации. Номера телефонов, соответствующие этому формату, могут содержать не более 15 цифр, они предваряются знаком плюс (+) и кодом страны. Например, номер телефона США в формате E.164 будет указан как +1XXX5550100. Для получения дополнительной информации см. E.164 на Wikipedia.

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

Вывод

operations -> (список)

Массив объектов, описывающих результат действия, например состояние запроса, метку времени запроса и ресурсы, затронутые запросом.

(структура)

Описание операции API.

id -> (строка)

Идентификатор операции.

resourceName -> (строка)

Название ресурса.

resourceType -> (строка)

Тип ресурса.

createdAt -> (метка времени)

Метка времени инициализации операции (1479816991.349).

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

Область и зона доступности Amazon Web Services.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Название региона Amazon Web Services.

isTerminal -> (логическое)

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

operationDetails -> (строка)

Подробности операции (Debian-1GB-Ohio-1).

operationType -> (строка)

Тип операции.

status -> (строка)

Состояние операции.

statusChangedAt -> (метка времени)

Метка времени изменения состояния (1479816991.349).

errorCode -> (строка)

Код ошибки.

errorDetails -> (строка)

Подробности ошибки.

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

Spec-Zone.ru

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