Spec-Zone.ru › AWS CLI v2

[ aws . chime ]

list-phone-numbers

Описание

Перечисляет номера телефонов для указанной учетной записи Amazon Chime, пользователя Amazon Chime, соединителя Amazon Chime Voice или группы соединителей Amazon Chime Voice.

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

Синтаксис

  list-phone-numbers
[--status <value>]
[--product-type <value>]
[--filter-name <value>]
[--filter-value <value>]
[--max-results <value>]
[--next-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]

Параметры

--status (строка)

Статус номера телефона.

Возможные значения:

  • AcquireInProgress
  • AcquireFailed
  • Unassigned
  • Assigned
  • ReleaseInProgress
  • DeleteInProgress
  • ReleaseFailed
  • DeleteFailed

--product-type (строка)

Тип продукта номера телефона.

Возможные значения:

  • BusinessCalling
  • VoiceConnector
  • SipMediaApplicationDialIn

--filter-name (строка)

Фильтр для ограничения количества результатов.

Возможные значения:

  • AccountId
  • UserId
  • VoiceConnectorId
  • VoiceConnectorGroupId
  • SipRuleId

--filter-value (строка)

Значение для использования в фильтре.

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

Максимальное количество результатов, возвращаемых в одном запросе.

--next-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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/отключение цветного вывода.

  • on
  • off
  • auto

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

Примеры

Примечание

Для использования следующих примеров, вы должны иметь установленный и настроенный AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования для unix-подобных терминалов. Эти примеры потребуется адаптировать к правилам цитирования вашего терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для перечисления номеров телефонов для учетной записи Amazon Chime

Следующий list-phone-numbers пример перечисляет номера телефонов, связанные с учетной записью Amazon Chime администратора.

aws chime list-phone-numbers

Эта команда не производит никакого вывода. Вывод:

{
    "PhoneNumbers": [
        {
            "PhoneNumberId": "%2B12065550100",
            "E164PhoneNumber": "+12065550100",
            "Type": "Local",
            "ProductType": "VoiceConnector",
            "Status": "Assigned",
            "Capabilities": {
                "InboundCall": true,
                "OutboundCall": true,
                "InboundSMS": true,
                "OutboundSMS": true,
                "InboundMMS": true,
                "OutboundMMS": true
            },
            "Associations": [
                {
                    "Value": "abcdef1ghij2klmno3pqr4",
                    "Name": "VoiceConnectorId",
                    "AssociatedTimestamp": "2019-10-28T18:40:37.453Z"
                }
            ],
            "CallingNameStatus": "UpdateInProgress",
            "CreatedTimestamp": "2019-08-12T22:10:20.521Z",
            "UpdatedTimestamp": "2019-10-28T18:42:07.964Z"
        },
        {
            "PhoneNumberId": "%2B12065550101",
            "E164PhoneNumber": "+12065550101",
            "Type": "Local",
            "ProductType": "VoiceConnector",
            "Status": "Assigned",
            "Capabilities": {
                "InboundCall": true,
                "OutboundCall": true,
                "InboundSMS": true,
                "OutboundSMS": true,
                "InboundMMS": true,
                "OutboundMMS": true
            },
            "Associations": [
                {
                    "Value": "abcdef1ghij2klmno3pqr4",
                    "Name": "VoiceConnectorId",
                    "AssociatedTimestamp": "2019-10-28T18:40:37.511Z"
                }
            ],
            "CallingNameStatus": "UpdateInProgress",
            "CreatedTimestamp": "2019-08-12T22:10:20.521Z",
            "UpdatedTimestamp": "2019-10-28T18:42:07.960Z"
        }
    ]
}

Для получения дополнительной информации см. работу с номерами телефонов в Руководстве по администрированию Amazon Chime.

Вывод

PhoneNumbers -> (список)

Подробности номера телефона.

(структура)

Номер телефона, используемый для Amazon Chime Business Calling или Amazon Chime Voice Connector.

PhoneNumberId -> (строка)

Идентификатор номера телефона.

E164PhoneNumber -> (строка)

Номер телефона в формате E.164.

Country -> (строка)

Страна номера телефона. Формат: ISO 3166-1 alpha-2.

Type -> (строка)

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

ProductType -> (строка)

Тип продукта номера телефона.

Status -> (строка)

Статус номера телефона.

Capabilities -> (структура)

Возможности номера телефона.

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

Разрешает или запрещает входящие звонки для указанного номера телефона.

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

Разрешает или запрещает исходящие звонки для указанного номера телефона.

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

Разрешает или запрещает входящие SMS-сообщения для указанного номера телефона.

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

Разрешает или запрещает исходящие SMS-сообщения для указанного номера телефона.

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

Разрешает или запрещает входящие MMS-сообщения для указанного номера телефона.

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

Разрешает или запрещает исходящие MMS-сообщения для указанного номера телефона.

Associations -> (список)

Связи номера телефона.

(структура)

Связи номера телефона, такие как идентификатор учетной записи Amazon Chime, идентификатор пользователя Amazon Chime, идентификатор соединителя Amazon Chime Voice или идентификатор группы соединителей Amazon Chime Voice.

Value -> (строка)

Содержит идентификатор сущности, указанный в Name.

Name -> (строка)

Определяет связь с идентификатором учетной записи Amazon Chime, идентификатором пользователя, идентификатором соединителя Amazon Chime Voice или идентификатором группы соединителей Amazon Chime Voice.

AssociatedTimestamp -> (метка времени)

Отметка времени связи номера телефона в формате ISO 8601.

CallingName -> (строка)

Имя исходящего вызова, связанное с номером телефона.

CallingNameStatus -> (строка)

Статус имени исходящего вызова.

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

Отметка времени создания номера телефона в формате ISO 8601.

UpdatedTimestamp -> (метка времени)

Отметка времени обновления номера телефона в формате ISO 8601.

DeletionTimestamp -> (метка времени)

Отметка времени удаления номера телефона в формате ISO 8601.

NextToken -> (строка)

Токен для получения следующей страницы результатов.

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

Spec-Zone.ru

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