Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

request-sender-id

Описание

Запросить новый идентификатор отправителя, для которого не требуется регистрация.

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

Синтаксис

  request-sender-id
--sender-id <value>
--iso-country-code <value>
[--message-types <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]

Параметры

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

Строка идентификатора отправителя для запроса.

--iso-country-code (строка)

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

--message-types (список)

Тип сообщения. Допустимые значения: TRANSACTIONAL для критически важных или временных сообщений и PROMOTIONAL для некритически важных или временных сообщений.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  TRANSACTIONAL
  PROMOTIONAL

--deletion-protection-enabled | --no-deletion-protection-enabled (логическое значение)

По умолчанию установлено в false. При значении true идентификатор отправителя не может быть удален.

--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
  • текст
  • таблица
  • 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.

Вывод

SenderIdArn -> (строка)

Amazon Resource Name (ARN), связанный с SenderId.

SenderId -> (строка)

Запрошенный идентификатор отправителя.

IsoCountryCode -> (строка)

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

MessageTypes -> (список)

Тип сообщения. Допустимые значения: TRANSACTIONAL для критически важных или временных сообщений и PROMOTIONAL для некритически важных или временных сообщений.

(строка)

MonthlyLeasingPrice -> (строка)

Ежемесячная цена (в долларах США) аренды идентификатора отправителя.

DeletionProtectionEnabled -> (логическое значение)

По умолчанию установлено в false. При значении true идентификатор отправителя не может быть удален.

Registered -> (логическое значение)

True, если идентификатор отправителя зарегистрирован.

Tags -> (список)

Массив тегов (пар «ключ-значение») для ассоциации с идентификатором отправителя.

(структура)

Список тегов для добавления к указанной теме.

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

Идентификатор или имя ключа тега.

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

Строковое значение, связанное с ключом тега.

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

Spec-Zone.ru

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