[ aws . pinpoint-sms-voice-v2 ]
описание-типов-регистрации
Описание
Получает указанные определения типов регистрации. С помощью DescribeRegistrationTypeDefinitions можно просмотреть требования к созданию, заполнению и отправке каждого типа регистрации.
См. также: Документация по API AWS
describe-registration-type-definitions является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничную загрузку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: RegistrationTypeDefinitions
Синтаксис
describe-registration-type-definitions
[--registration-types <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-types (список)
Тип формы регистрации. Список RegistrationTypes можно найти с помощью действия DescribeRegistrationTypeDefinitions.
(строка)
Синтаксис:
"string" "string" ...
--filters (список)
Массив объектов RegistrationFilter для фильтрации результатов.
(структура)
Определение фильтра для фильтрации типов регистрации, которые соответствуют заданным критериям.
Имя -> (строка)
Значения -> (список)
Массив значений для фильтрации.
(строка)
Сокращённый синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "supported-association-resource-type"|"supported-association-iso-country-code",
"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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
RegistrationTypeDefinitions -> (список)
Тип формы регистрации. Список RegistrationTypes можно найти с помощью действия DescribeRegistrationTypeDefinitions.
(структура)
Предоставляет информацию о поддерживаемом типе регистрации.
RegistrationType -> (строка)
SupportedAssociations -> (список)
Поддерживаемое поведение ассоциации для типа регистрации.
(структура)
Правила обработки, когда регистрация может быть связана с идентификатором отправки и отключена от идентификатора отправки.
ResourceType -> (строка)
IsoCountryCode -> (строка)
AssociationBehavior -> (строка)
Поведение ассоциации.
-
ASSOCIATE_BEFORE_SUBMITИдентификатор отправки должен быть предоставлен при создании регистрации. -
ASSOCIATE_ON_APPROVALЭто относится ко всем регистрационным данным отправителя. Идентификатор отправителя будет автоматически предоставлен после утверждения регистрации. -
ASSOCIATE_AFTER_COMPLETEЭто относится к регистрационным данным телефонного номера, когда вы должны сначала завершить регистрацию, а затем связать один или несколько телефонных номеров позже. Например, кампании 10DLC и длинные коды.
DisassociationBehavior -> (строка)
Поведение отсоединения.
-
DISASSOCIATE_ALL_CLOSES_REGISTRATIONВсе идентификаторы отправки должны быть отключены от регистрации, прежде чем регистрация сможет быть закрыта. -
DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATIONВсе идентификаторы отправки должны быть отключены от регистрации, прежде чем регистрация сможет быть удалена. -
DELETE_REGISTRATION_DISASSOCIATESРегистрация может быть удалена, и все идентификаторы отправки будут отключены.
DisplayHints -> (структура)
Предоставляет справочную информацию по регистрации.
Title -> (строка)
ShortDescription -> (строка)
LongDescription -> (строка)
DocumentationTitle -> (строка)
DocumentationLink -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.