Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-sms-voice-v2 ]

обновить-номер-телефона

Описание

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

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

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

Синтаксис

  update-phone-number
--phone-number-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>]
[--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]

Параметры

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

Уникальный идентификатор номера телефона. Допустимые значения для этого поля — PhoneNumberId или PhoneNumberArn.

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

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

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

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

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

Amazon Resource Name (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 для добавления номера телефона. Допустимые значения для этого поля — OutOutListName или OutOutListArn.

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

По умолчанию установлено в false. При установке в 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 (строка)

Использование определенного профиля из файла учетных данных.

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

Вывод

PhoneNumberArn -> (строка)

Amazon Resource Name (ARN) обновленного номера телефона.

PhoneNumberId -> (строка)

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

PhoneNumber -> (строка)

Номер телефона, который был обновлен.

Status -> (строка)

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

IsoCountryCode -> (строка)

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

MessageType -> (строка)

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

NumberCapabilities -> (список)

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

(строка)

NumberType -> (строка)

Тип номера, который был запрошен.

MonthlyLeasingPrice -> (строка)

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

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

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

TwoWayChannelArn -> (строка)

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

TwoWayChannelRole -> (строка)

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

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

Истинно, если самостоятельные отписки включены.

OptOutListName -> (строка)

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

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

При установке в true номер телефона не может быть удален.

RegistrationId -> (строка)

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

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

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

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

Spec-Zone.ru

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