[ aws . pinpoint-sms-voice-v2 ]
request-phone-number
Описание
Запросить номер телефона исходящей линии для использования в вашей учетной записи. Дополнительную информацию о запросе номера телефона см. в руководстве пользователя AWS End User Messaging SMS, раздел «Запрос номера телефона».
См. также: Документацию API AWS
Синтаксис
request-phone-number
--iso-country-code <value>
--message-type <value>
--number-capabilities <value>
--number-type <value>
[--opt-out-list-name <value>]
[--pool-id <value>]
[--registration-id <value>]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
Параметры
--iso-country-code (строка)
--message-type (строка)
Тип сообщения. Допустимые значения: TRANSACTIONAL для критически важных или срочных сообщений и PROMOTIONAL для сообщений, не являющихся критически важными или срочными.
Возможные значения:
TRANSACTIONALPROMOTIONAL
--number-capabilities (список)
Указывает, будет ли номер телефона использоваться для текстовых сообщений, голосовых сообщений или обоих типов.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
SMS
VOICE
MMS
--number-type (строка)
Тип запрашиваемого номера телефона.
При запросе SIMULATOR номера телефона, необходимо установить MessageType как TRANSACTIONAL .
Возможные значения:
LONG_CODETOLL_FREETEN_DLCSIMULATOR
--opt-out-list-name (строка)
Имя OptOutList для ассоциации с номером телефона. Можно использовать OptOutListName или OptOutListArn.
Предупреждение
Если вы используете общие ресурсы AWS End User Messaging SMS и Voice, то необходимо использовать полное Amazon Resource Name (ARN).--pool-id (строка)
Пул для ассоциации с номером телефона. Можно использовать PoolId или PoolArn.
Предупреждение
Если вы используете общие ресурсы AWS End User Messaging SMS и Voice, то необходимо использовать полное Amazon Resource Name (ARN).--registration-id (строка)
--deletion-protection-enabled | --no-deletion-protection-enabled (булево)
--tags (список)
Массив тегов (пар ключ-значение) для ассоциации с запрашиваемым номером телефона.
(структура)
Список тегов, которые необходимо добавить к указанной теме.
Ключ -> (строка)
Значение -> (строка)
Сокращенный синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--client-token (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, поскольку строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.
--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.
Вывод
PhoneNumberArn -> (строка)
PhoneNumberId -> (строка)
PhoneNumber -> (строка)
Status -> (строка)
IsoCountryCode -> (строка)
MessageType -> (строка)
NumberCapabilities -> (список)
Указывает, будет ли номер телефона использоваться для текстовых сообщений, голосовых сообщений или обоих типов.
(строка)
NumberType -> (строка)
MonthlyLeasingPrice -> (строка)
TwoWayEnabled -> (булево)
TwoWayChannelArn -> (строка)
TwoWayChannelRole -> (строка)
SelfManagedOptOutsEnabled -> (булево)
OptOutListName -> (строка)
DeletionProtectionEnabled -> (булево)
PoolId -> (строка)
RegistrationId -> (строка)
Tags -> (список)
Массив пар ключ-значение тегов, которые связаны с номером телефона.
(структура)
Список тегов, которые необходимо добавить к указанной теме.
Ключ -> (строка)
Значение -> (строка)
CreatedTimestamp -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.