Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

list-pool-origination-identities

Описание

Отображает все связанные идентификаторы отправки в вашем пуле.

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

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

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

Синтаксис

  list-pool-origination-identities
--pool-id <value>
[--filters <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]

Параметры

--pool-id (строка)

Уникальный идентификатор пула. Это значение может быть либо PoolId, либо PoolArn.

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

Если вы используете общий ресурс AWS для отправки SMS и голосовой связи, то должны использовать полное имя Amazon Resource Name (ARN).

--filters (список)

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

(структура)

Информация об идентификаторах отправки, связанных с пулом, которая соответствует заданным критериям.

Name -> (строка)

Название атрибута для фильтрации.

Values -> (список)

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

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "iso-country-code"|"number-capability",
    "Values": ["string", ...]
  }
  ...
]

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

PoolArn -> (строка)

Amazon Resource Name (ARN) для пула.

PoolId -> (строка)

Уникальный PoolId пула.

OriginationIdentities -> (список)

Массив объектов OriginationIdentityMetadata.

(структура)

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

OriginationIdentityArn -> (строка)

Amazon Resource Name (ARN), связанный с идентификатором отправки.

OriginationIdentity -> (строка)

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

IsoCountryCode -> (строка)

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

NumberCapabilities -> (список)

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

(строка)

PhoneNumber -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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