Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

describe-registration-versions

Описание

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

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

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

Синтаксис

  describe-registration-versions
--registration-id <value>
[--version-numbers <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-id (строка)

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

--version-numbers (список)

Массив номеров версий регистрации.

(целое число)

Синтаксис:

long long ...

--filters (список)

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

(структура)

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "registration-version-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
  • 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-auto-prompt (булево)

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

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

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

Вывод

RegistrationArn -> (строка)

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

RegistrationId -> (строка)

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

RegistrationVersions -> (список)

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

(структура)

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

VersionNumber -> (целое число)

Номер версии регистрации.

RegistrationVersionStatus -> (строка)

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

  • APPROVED : Ваша регистрация одобрена.
  • ARCHIVED : Предыдущая одобренная версия регистрации переходит в этот статус, когда одобрена более новая версия.
  • DENIED : Вам необходимо исправить регистрацию и повторно отправить ее.
  • DISCARDED : Вы отказались от этой версии своей регистрации, чтобы начать заново с новой версией.
  • DRAFT : Начальный статус версии регистрации после ее создания.
  • REQUIRES_AUTHENTICATION : Вам необходимо завершить аутентификацию по электронной почте.
  • REVIEWING : Ваша регистрация принята и находится на рассмотрении.
  • REVOKED : Ваша ранее одобренная регистрация аннулирована.
  • SUBMITTED : Ваша регистрация отправлена.

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

Объект RegistrationVersionStatusHistory содержит временные метки изменений статуса резервации.

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

Время, когда регистрация находилась в состоянии черновика, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии отправки, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии рассмотрения, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии требования аутентификации, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии одобрения, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии удаления, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии отклонения, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии аннулирования, в формате временной метки Unix.

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

Время, когда регистрация находилась в состоянии архивации, в формате временной метки Unix.

DeniedReasons -> (список)

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

(структура)

Предоставляет причину отклонения регистрации.

Reason -> (строка)

Причина отклонения регистрации.

ShortDescription -> (строка)

Краткое описание причины отклонения.

LongDescription -> (строка)

Подробное описание причины отклонения.

DocumentationTitle -> (строка)

Название документа.

DocumentationLink -> (строка)

Ссылка на документ.

NextToken -> (строка)

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

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

Spec-Zone.ru

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