Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

list-phone-numbers-v2

Описание

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

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

Примечание

  • При указании ARN экземпляра ListPhoneNumbersV2 возвращает только телефонные номера, привязанные к этому экземпляру.
  • При указании ARN группы распределения трафика ListPhoneNumbersV2 возвращает только телефонные номера, привязанные к этой группе.

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

list-phone-numbers-v2 является постраничной операцией. Для получения всех результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query с постраничным ответом аргумент --query должен извлекать данные из результатов следующих выражений запроса: ListPhoneNumbersSummaryList

Синтаксис

  list-phone-numbers-v2
[--target-arn <value>]
[--instance-id <value>]
[--phone-number-country-codes <value>]
[--phone-number-types <value>]
[--phone-number-prefix <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

Amazon Resource Name (ARN) экземпляра Amazon Connect или группы распределения трафика, через который маршрутизируется входящий трафик по телефонному номеру. Если оба TargetArn и InstanceId не указаны, этот API выводит список номеров, привязанных ко всем экземплярам Amazon Connect в вашей учетной записи в том же регионе Amazon Web Services, что и запрос.

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

Идентификатор экземпляра Amazon Connect, к которому привязаны телефонные номера. Идентификатор экземпляра можно найти в Amazon Resource Name (ARN) экземпляра. Если оба TargetArn и InstanceId не указаны, этот API выводит список номеров, привязанных ко всем экземплярам Amazon Connect в вашей учетной записи в том же регионе AWS, что и запрос.

--phone-number-country-codes (список)

Код страны по ISO.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AF
  AL
  DZ
  AS
  AD
  AO
  AI
  AQ
  AG
  AR
  AM
  AW
  AU
  AT
  AZ
  BS
  BH
  BD
  BB
  BY
  BE
  BZ
  BJ
  BM
  BT
  BO
  BA
  BW
  BR
  IO
  VG
  BN
  BG
  BF
  BI
  KH
  CM
  CA
  CV
  KY
  CF
  TD
  CL
  CN
  CX
  CC
  CO
  KM
  CK
  CR
  HR
  CU
  CW
  CY
  CZ
  CD
  DK
  DJ
  DM
  DO
  TL
  EC
  EG
  SV
  GQ
  ER
  EE
  ET
  FK
  FO
  FJ
  FI
  FR
  PF
  GA
  GM
  GE
  DE
  GH
  GI
  GR
  GL
  GD
  GU
  GT
  GG
  GN
  GW
  GY
  HT
  HN
  HK
  HU
  IS
  IN
  ID
  IR
  IQ
  IE
  IM
  IL
  IT
  CI
  JM
  JP
  JE
  JO
  KZ
  KE
  KI
  KW
  KG
  LA
  LV
  LB
  LS
  LR
  LY
  LI
  LT
  LU
  MO
  MK
  MG
  MW
  MY
  MV
  ML
  MT
  MH
  MR
  MU
  YT
  MX
  FM
  MD
  MC
  MN
  ME
  MS
  MA
  MZ
  MM
  NA
  NR
  NP
  NL
  AN
  NC
  NZ
  NI
  NE
  NG
  NU
  KP
  MP
  NO
  OM
  PK
  PW
  PA
  PG
  PY
  PE
  PH
  PN
  PL
  PT
  PR
  QA
  CG
  RE
  RO
  RU
  RW
  BL
  SH
  KN
  LC
  MF
  PM
  VC
  WS
  SM
  ST
  SA
  SN
  RS
  SC
  SL
  SG
  SX
  SK
  SI
  SB
  SO
  ZA
  KR
  ES
  LK
  SD
  SR
  SJ
  SZ
  SE
  CH
  SY
  TW
  TJ
  TZ
  TH
  TG
  TK
  TO
  TT
  TN
  TR
  TM
  TC
  TV
  VI
  UG
  UA
  AE
  GB
  US
  UY
  UZ
  VU
  VA
  VE
  VN
  WF
  EH
  YE
  ZM
  ZW

--phone-number-types (список)

Тип телефонного номера.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  TOLL_FREE
  DID
  UIFN
  SHARED
  THIRD_PARTY_TF
  THIRD_PARTY_DID
  SHORT_CODE

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

Префикс телефонного номера. Если указан, он должен содержать + в составе кода страны.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, заданные в JSON. Передача произвольных двоичных данных с помощью значения, заданного в JSON, невозможна, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен, указывающий с какой позиции начинать постраничный вывод. Это значение NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, при этом в каждом вызове извлекается меньше элементов. Это может помочь предотвратить истечение времени ожидания AWS-сервисов.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS Command Line Interface.

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

Вывод

NextToken -> (строка)

Если есть дополнительные результаты, это токен для следующего набора результатов.

ListPhoneNumbersSummaryList -> (список)

Информация о телефонных номерах, привязанных к вашим экземплярам Amazon Connect или группам распределения трафика.

(структура)

Информация о телефонных номерах, привязанных к вашему экземпляру Amazon Connect или группе распределения трафика.

PhoneNumberId -> (строка)

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

PhoneNumberArn -> (строка)

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

PhoneNumber -> (строка)

Телефонный номер. Телефонные номера отформатированы [+] [country code] [subscriber number including area code] .

PhoneNumberCountryCode -> (строка)

Код страны по ISO.

PhoneNumberType -> (строка)

Тип телефонного номера.

TargetArn -> (строка)

Amazon Resource Name (ARN) экземпляра Amazon Connect или группы распределения трафика, через который маршрутизируется входящий трафик по телефонному номеру.

InstanceId -> (строка)

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

PhoneNumberDescription -> (строка)

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

SourcePhoneNumberArn -> (строка)

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

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

Spec-Zone.ru

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