Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

обновление-пула

Описание

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

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

Синтаксис

  update-pool
--pool-id <value>
[--two-way-enabled | --no-two-way-enabled]
[--two-way-channel-arn <value>]
[--two-way-channel-role <value>]
[--self-managed-opt-outs-enabled | --no-self-managed-opt-outs-enabled]
[--opt-out-list-name <value>]
[--shared-routes-enabled | --no-shared-routes-enabled]
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--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]

Параметры

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

Уникальный идентификатор пула для обновления. Допустимые значения — PoolId или PoolArn.

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

Если вы используете общий ресурс AWS End User Messaging SMS и Voice, то вы должны использовать полное имя ресурса Amazon (ARN).

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

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

--two-way-channel-arn (строка)

Полное имя ресурса Amazon (ARN) канала двусторонней связи.

--two-way-channel-role (строка)

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

--self-managed-opt-outs-enabled | --no-self-managed-opt-outs-enabled (логическое значение)

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

--opt-out-list-name (строка)

Список OptOutList для связывания с пулом. Допустимые значения — OptOutListName или OptOutListArn.

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

Если вы используете общий ресурс AWS End User Messaging SMS и Voice, то вы должны использовать полное имя ресурса Amazon (ARN).

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

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

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

При установке в значение true пул нельзя удалить.

--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 (строка)

Используйте определённый профиль из файла credencial.

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

Вывод

PoolArn -> (строка)

ARN пула.

PoolId -> (строка)

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

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

Текущий статус запроса обновления пула.

Тип сообщения -> (строка)

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

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

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

TwoWayChannelArn -> (строка)

Полное имя ресурса Amazon (ARN) канала двусторонней связи.

TwoWayChannelRole -> (строка)

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

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

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

OptOutListName -> (строка)

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

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

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

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

При установке в значение true пул нельзя удалить.

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

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

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

Spec-Zone.ru

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