номер-телефона-заявка

Описание

Заявляет о доступности телефонного номера в вашем экземпляре Amazon Connect или группе распределения трафика. Вы можете вызвать этот API только в той же области Amazon Web Services, где был создан экземпляр Amazon Connect или группа распределения трафика.

Дополнительную информацию о том, как использовать эту операцию, см. в разделах «Заявление о телефонном номере в вашей стране» и «Заявление о телефонных номерах в группы распределения трафика» в Руководстве администратора Amazon Connect.

Если вы планируете часто заявлять и освобождать номера, свяжитесь с нами для исключения из квоты. В противном случае возможно, что вы будете заблокированы от заявления и освобождения каких-либо дополнительных номеров до истечения срока давности самого старого выпущенного номера, который может составить до 180 дней.

По умолчанию вы можете заявлять и освобождать до 200% от максимального количества активных телефонных номеров. Если вы заявляете и освобождаете телефонные номера с помощью пользовательского интерфейса или API в течение цикла в 180 дней, который превышает 200% от вашей квоты уровня обслуживания телефонных номеров, вы будете заблокированы от заявления каких-либо дополнительных номеров до истечения срока давности самого старого выпущенного номера, который может составить до 180 дней.

Например, если у вас уже есть 99 заявленных номеров и квота уровня обслуживания в 99 телефонных номеров, и в любой период в 180 дней вы освобождаете 99, заявляете о 99 и затем освобождаете 99, вы превысите лимит 200%. В этот момент вас заблокируют от заявления каких-либо дополнительных номеров, пока вы не откроете тикет поддержки Amazon Web Services.

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

Синтаксис

  claim-phone-number
[--target-arn <value>]
[--instance-id <value>]
--phone-number <value>
[--phone-number-description <value>]
[--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]

Параметры

--target-arn (строка)

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

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

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

--tags (карта)

Упрощенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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
• текст
• таблица
• 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 (булево)

Отключить тулбар AWS CLI для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров входных данных CLI.

Вывод

PhoneNumberId -> (строка)

PhoneNumberArn -> (строка)