Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

describe-phone-numbers

Описание

Описывает указанный номер телефона исходящей связи или все номера телефонов в вашей учетной записи.

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

Если вы укажете идентификатор номера телефона, который недействителен, будет возвращено сообщение об ошибке.

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

describe-phone-numbers является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на запрос, содержащем постраничную обработку, аргумент --query должен извлекать данные из результатов следующих запросов: PhoneNumbers

Синтаксис

  describe-phone-numbers
[--phone-number-ids <value>]
[--filters <value>]
[--owner <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--phone-number-ids (список)

Уникальный идентификатор номеров телефонов, о которых нужно получить информацию. Это массив строк, которые могут быть либо PhoneNumberId, либо PhoneNumberArn.

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

Если вы используете общий ресурс AWS End User Messaging SMS и Voice, то должны использовать полное имя ресурса Amazon (ARN).

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Массив объектов PhoneNumberFilter для фильтрации результатов.

(структура)

Информация о номере телефона, соответствующая указанным критериям.

Name -> (строка)

Имя атрибута, по которому нужно отфильтровать.

Values -> (список)

Массив значений для фильтрации.

(строка)

Сокращенный синтаксис:

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "status"|"iso-country-code"|"message-type"|"number-capability"|"number-type"|"two-way-enabled"|"self-managed-opt-outs-enabled"|"opt-out-list-name"|"deletion-protection-enabled"|"two-way-channel-arn",
    "Values": ["string", ...]
  }
  ...
]

--owner (строка)

Используйте SELF для фильтрации списка номеров телефонов, принадлежащих вашей учетной записи, или используйте SHARED для фильтрации по номерам телефонов, общих с вашей учетной записью. Параметры Owner и PhoneNumberIds нельзя использовать одновременно.

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

  • SELF
  • SHARED

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет принята буквально. Это может не быть указано вместе с --cli-input-yaml.

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

Токен для указания места начала постраничной обработки. Это NextToken из ранее укороченного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

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

Вывод

PhoneNumbers -> (список)

Массив объектов PhoneNumberInformation, содержащих детали запрошенных номеров телефонов.

(структура)

Информация о номере телефона в формате E.164 в учетной записи Amazon Web Services.

PhoneNumberArn -> (строка)

Имя ресурса Amazon (ARN), связанное с номером телефона.

PhoneNumberId -> (строка)

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

PhoneNumber -> (строка)

Номер телефона в формате E.164.

Status -> (строка)

Текущее состояние номера телефона.

IsoCountryCode -> (строка)

Двухбуквенный код в формате ISO 3166-1 alpha-2 для страны или региона.

MessageType -> (строка)

Тип сообщения. Допустимые значения: TRANSACTIONAL для критических или временных сообщений и PROMOTIONAL для сообщений, которые не являются критическими или временными.

NumberCapabilities -> (список)

Описывает, можно ли использовать идентификатор исходящей связи для текстовых сообщений, голосовых вызовов или для обоих.

(строка)

NumberType -> (строка)

Тип номера телефона.

MonthlyLeasingPrice -> (строка)

Цена (в долларах США) за аренду номера телефона.

TwoWayEnabled -> (логическое значение)

По умолчанию установлено в false. При установке в true вы можете получать входящие текстовые сообщения от ваших получателей с помощью TwoWayChannelArn.

TwoWayChannelArn -> (строка)

Имя ресурса Amazon (ARN) канала двусторонней связи.

TwoWayChannelRole -> (строка)

Необязательный IAM Role Arn для службы, чтобы она могла получить право отправлять входящие SMS-сообщения.

SelfManagedOptOutsEnabled -> (логическое значение)

При установке в false, когда получатель отправляет сообщение, начинающееся с HELP или STOP, одному из ваших выделенных номеров, AWS End User Messaging SMS и Voice автоматически отвечает настраиваемым сообщением и добавляет получателя в список OptOutList. При установке в true вы несете ответственность за ответы на запросы HELP и STOP. Вы также несете ответственность за отслеживание и выполнение запросов отказа от подписки. Для получения дополнительной информации см. Автоматическое управление отказами от подписки

OptOutListName -> (строка)

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

DeletionProtectionEnabled -> (логическое значение)

При установке в true номер телефона не может быть удален.

PoolId -> (строка)

Уникальный идентификатор пула, связанного с номером телефона.

RegistrationId -> (строка)

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

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

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

NextToken -> (строка)

Токен для использования для следующего набора результатов постраничной обработки. Если это поле пустое, больше результатов нет.

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

Spec-Zone.ru

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