Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

Удалить пул

Описание

Удаляет существующий пул. Удаление пула отсоединяет все идентификаторы отправки от этого пула.

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

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

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

Синтаксис

  delete-pool
--pool-id <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]

Параметры

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

PoolId или PoolArn пула, который нужно удалить. Вы можете использовать DescribePools для поиска значений PoolId и PoolArn.

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

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

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

Вывод

PoolArn -> (строка)

Amazon Resource Name (ARN) удаленного пула.

PoolId -> (строка)

PoolId удаленного пула.

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

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

  • СОЗДАЕТСЯ: Пул в настоящее время создается и пока недоступен для использования.
  • АКТИВЕН: Пул активен и доступен для использования.
  • УДАЛЯЕТСЯ: Пул удаляется.

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

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

Взаимодействие включено -> (логическое значение)

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

ARN канала взаимодействия -> (строка)

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

Роль канала взаимодействия -> (строка)

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

Включены личные отказания от участия -> (логическое значение)

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

Название списка отказавшихся от участия -> (строка)

Название списка отказавшихся от участия, связанного с удаленным пулом.

Включены общие маршруты -> (логическое значение)

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

Дата создания -> (метка времени)

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

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

Spec-Zone.ru

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