Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

создать-пул

Описание

Создаёт новый пул и связывает указанный идентификатор источника с пулом. Пул может включать один или несколько телефонных номеров и идентификаторов отправителей, связанных с вашей учётной записью Amazon Web Services.

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

Если идентификатор источника — это телефонный номер, и он уже связан с другим пулом, возвращается ошибка. Один идентификатор отправителя может быть связан с несколькими пулами.

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

Синтаксис

  create-pool
--origination-identity <value>
--iso-country-code <value>
--message-type <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]

Параметры

--origination-identity (строка)

Идентификатор источника, который нужно использовать, например, PhoneNumberId, PhoneNumberArn, SenderId или SenderIdArn. Вы можете использовать DescribePhoneNumbers для поиска значений PhoneNumberId и PhoneNumberArn, а DescribeSenderIds — для получения значений SenderId и SenderIdArn.

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

Предупреждение

Если вы используете общий ресурс SMS и голосовой связи AWS для конечных пользователей, то вы должны использовать полное Amazon Resource Name (ARN).

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

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

--message-type (строка)

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

Возможные значения:

  • TRANSACTIONAL
  • PROMOTIONAL

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

По умолчанию это значение установлено в false. При значении true пул не может быть удалён. Вы можете изменить это значение с помощью действия UpdatePool.

--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.

Вывод

PoolArn -> (строка)

Amazon Resource Name (ARN) пула.

PoolId -> (строка)

Уникальный идентификатор пула.

Статус -> (строка)

Текущий статус пула.

  • CREATING: Пул в процессе создания и пока недоступен для использования.
  • ACTIVE: Пул активен и доступен для использования.
  • DELETING: Пул удаляется.

MessageType -> (строка)

Тип сообщения для использования пулом.

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

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

TwoWayChannelArn -> (строка)

Amazon Resource Name (ARN) двухстороннего канала.

TwoWayChannelRole -> (строка)

Необязательный IAM Role Arn для сервиса, чтобы иметь возможность отправлять входящие SMS-сообщения.

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

По умолчанию установлено в false. Когда конечный получатель отправляет сообщение, начинающееся с HELP или STOP, одному из ваших выделенных номеров, AWS End User Messaging SMS и Voice автоматически отвечает настраиваемым сообщением и добавляет конечного получателя в список OptOutList. При значении true вы несете ответственность за ответ на запросы HELP и STOP. Вы также несете ответственность за отслеживание и выполнение запросов об отказе от подписки.

OptOutListName -> (строка)

Имя OptOutList, связанного с пулом.

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

Указывает, включены ли общие маршруты для пула. Установлено в false, и только идентификаторы источников в этом пуле используются для отправки сообщений.

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

При значении true включена защита от удаления. По умолчанию установлено в false.

Tags -> (список)

Массив тегов (пар ключ-значение), связанных с пулом.

(структура)

Список тегов, которые необходимо добавить к указанной теме.

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

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

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

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

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

Время создания пула в формате временной метки Unix.

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

Spec-Zone.ru

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