describe-phone-number
Описание
Получение подробной информации и статуса телефонного номера, закреплённого за вашей инстанцией Amazon Connect или группой распределения трафика.
Предупреждение
Если номер закреплён за группой распределения трафика и вы вызываете API в той же области Amazon Web Services, где была создана группа распределения трафика, вы можете использовать либо ARN телефонного номера, либо значение UUID в параметре запроса URIPhoneNumberId. Однако, если номер закреплён за группой распределения трафика и вы вызываете этот API в другой области Amazon Web Services, связанной с группой распределения трафика, вы должны предоставить полное ARN телефонного номера. Если в этом сценарии будет предоставлено значение UUID, вы получите ResourceNotFoundException.См. также: Документация API AWS
Синтаксис
describe-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 (строка)
--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.
Вывод
ClaimedPhoneNumberSummary -> (структура)
Информация о телефонном номере, закрепленном за вашей инстанцией Amazon Connect или группой распределения трафика.
PhoneNumberId -> (строка)
PhoneNumberArn -> (строка)
PhoneNumber -> (строка)
[+] [country code] [subscriber number including area code] .PhoneNumberCountryCode -> (строка)
PhoneNumberType -> (строка)
PhoneNumberDescription -> (строка)
TargetArn -> (строка)
InstanceId -> (строка)
Tags -> (карта)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { “Теги”: {“ключ1”:”значение1”, “ключ2”:”значение2”} }.
ключ -> (строка)
значение -> (строка)
PhoneNumberStatus -> (структура)
Статус телефонного номера.
-
CLAIMEDозначает, что предыдущая операция ClaimPhoneNumber или UpdatePhoneNumber завершилась успешно. -
IN_PROGRESSозначает, что операция ClaimPhoneNumber, UpdatePhoneNumber или UpdatePhoneNumberMetadata всё ещё выполняется и не завершена. Вы можете вызвать DescribePhoneNumber позже, чтобы проверить, завершилась ли предыдущая операция. -
FAILEDуказывает, что предыдущая операция ClaimPhoneNumber или UpdatePhoneNumber завершилась неудачно. Она будет включать сообщение, указывающее причину неудачи. Распространённой причиной неудачи может быть то, что значениеTargetArn, к которому вы пытаетесь закрепить или обновить телефонный номер, достигло предела общего количества закреплённых номеров. Если вы получили статусFAILEDот вызова APIClaimPhoneNumber, у вас есть один день, чтобы повторить попытку закрепления телефонного номера, прежде чем номер будет возвращён в инвентарь для закрепления другими клиентами.
Примечание
Вы не будете оплачивать телефонный номер в течение 1-дневного периода, если закрепление номера завершится неудачно.Status -> (строка)
Message -> (строка)
SourcePhoneNumberArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.