Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

describe-registrations

Описание

Получает указанные регистрации.

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

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

Синтаксис

  describe-registrations
[--registration-ids <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]

Параметры

--registration-ids (список)

Массив уникальных идентификаторов каждой регистрации.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

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

(структура)

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

Имя -> (строка)

Имя атрибута для фильтрации.

Значения -> (список)

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

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "registration-type"|"registration-status",
    "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
  • текст
  • таблица
  • 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.

Вывод

Регистрации -> (список)

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

(структура)

Предоставляет информацию о запрошенной регистрации.

RegistrationArn -> (строка)

Amazon Resource Name (ARN) регистрации.

RegistrationId -> (строка)

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

RegistrationType -> (строка)

Тип формы регистрации. Список RegistrationTypes можно найти, используя действие DescribeRegistrationTypeDefinitions.

RegistrationStatus -> (строка)

Статус регистрации.

  • CLOSED: Номер телефона или идентификатор отправителя был удален, и вам также необходимо удалить регистрацию для номера.
  • CREATED: Ваша регистрация создана, но не отправлена.
  • COMPLETE: Ваша регистрация одобрена, и ваш идентификатор отправки создан.
  • DELETED: Регистрация удалена.
  • PROVISIONING: Ваша регистрация одобрена, и ваш идентификатор отправки создаётся.
  • REQUIRES_AUTHENTICATION: Необходимо завершить проверку электронной почты.
  • REQUIRES_UPDATES: Необходимо исправить вашу регистрацию и повторно отправить её.
  • REVIEWING: Ваша регистрация принята и находится на стадии проверки.
  • SUBMITTED: Ваша регистрация отправлена и ожидает проверки.

CurrentVersionNumber -> (длинное целое число)

Текущий номер версии регистрации.

ApprovedVersionNumber -> (длинное целое число)

Номер версии регистрации, которая была одобрена.

LatestDeniedVersionNumber -> (длинное целое число)

Последний номер версии регистрации, которая была отклонена.

AdditionalAttributes -> (карта)

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

ключ -> (строка)

значение -> (строка)

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

Время создания регистрации в формате временной метки UNIX.

NextToken -> (строка)

Токен для использования для следующего набора постраничных результатов. Вам не нужно предоставлять значение для этого поля в начальном запросе.

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

Spec-Zone.ru

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