Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

освобождение-номера-телефона

Описание

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

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

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

Синтаксис

  release-phone-number
--phone-number-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]

Параметры

--phone-number-id (строка)

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

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

Если вы используете общий ресурс AWS End User Messaging SMS и Voice, то должны использовать полное имя Amazon Resource Name (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-auto-prompt (логическое значение)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров CLI.

Вывод

PhoneNumberArn -> (строка)

PhoneNumberArn освобожденного номера телефона.

PhoneNumberId -> (строка)

PhoneNumberId освобожденного номера телефона.

PhoneNumber -> (строка)

Освобожденный номер телефона.

Status -> (строка)

Текущий статус запроса.

IsoCountryCode -> (строка)

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

MessageType -> (строка)

Тип сообщения, связанный с номером телефона.

NumberCapabilities -> (список)

Указывает, можно ли использовать номер для текстовых сообщений, голосовой связи или обоих.

(строка)

NumberType -> (строка)

Тип освобожденного номера.

MonthlyLeasingPrice -> (строка)

Ежемесячная цена номера телефона в долларах США.

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

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

TwoWayChannelArn -> (строка)

Amazon Resource Name (ARN) канала TwoWayChannel.

TwoWayChannelRole -> (строка)

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

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

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

OptOutListName -> (строка)

Имя OptOutList, связанного с номером телефона.

RegistrationId -> (строка)

Уникальный идентификатор регистрации.

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

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

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

Spec-Zone.ru

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