Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

import-phone-number

Описание

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

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

Вызовите API DescribePhoneNumber, чтобы проверить состояние предыдущей ImportPhoneNumber операции.

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

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

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

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

Синтаксис

  import-phone-number
--instance-id <value>
--source-phone-number-arn <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]

Параметры

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

Идентификатор экземпляра Amazon Connect. Вы можете найти идентификатор экземпляра в Amazon Resource Name (ARN) экземпляра.

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

ARN номера телефона, на который заявлено право собственности и который импортируется из внешней службы, например, Amazon Web Services End User Messaging. Если номер из Amazon Web Services End User Messaging, он выглядит как ARN номера телефона для импорта из Amazon Web Services End User Messaging.

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

Описание номера телефона.

--tags (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Теги”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }.

ключ -> (строка)

значение -> (строка)

Сокращенная синтаксическая форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указан, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API.

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

Вывод

PhoneNumberId -> (строка)

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

PhoneNumberArn -> (строка)

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

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

Spec-Zone.ru

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