Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-contact-methods

Описание

Возвращает информацию о настроенных методах связи. Укажите протокол в запросе, чтобы получить информацию о конкретном методе связи.

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

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

Синтаксис

  get-contact-methods
[--protocols <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]

Параметры

--protocols (список)

Протоколы, используемые для отправки уведомлений, такие как Email или SMS (сообщения по SMS).

Укажите протокол в запросе, чтобы получить информацию о конкретном протоколе метода связи.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Email
  SMS

--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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

contactMethods -> (список)

Массив объектов, описывающих методы связи.

(структура)

Описание метода связи.

Метод связи — это способ отправки уведомлений. Дополнительную информацию см. в разделе Уведомления в Amazon Lightsail.

contactEndpoint -> (строка)

Место назначения метода связи, например адрес электронной почты или номер мобильного телефона.

status -> (строка)

Текущий статус метода связи.

Метод связи может иметь следующие возможные статусы:

  • PendingVerification — Метод связи еще не проверен, и проверка еще не истекла.
  • Valid — Метод связи проверен.
  • InValid — Попытка проверки метода связи была предпринята, но проверка истекла.

protocol -> (строка)

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

name -> (строка)

Имя метода связи.

arn -> (строка)

Amazon Resource Name (ARN) метода связи.

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

Временная метка создания метода связи.

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

Объект, описывающий местоположение метода связи, например регион и зону доступности Amazon Web Services.

availabilityZone -> (строка)

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

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail метода связи.

supportCode -> (строка)

Код поддержки. Включите этот код в свое письмо в службу поддержки, если у вас есть вопросы о методе связи Lightsail. Этот код позволит нашей команде поддержки легче найти вашу информацию Lightsail.

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

Spec-Zone.ru

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