Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-voice ]

создание-сессии-прокси

Описание

Создаёт сессию прокси для указанного Amazon Chime SDK Voice Connector для указанных телефонных номеров участников.

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

Синтаксис

  create-proxy-session
--voice-connector-id <value>
--participant-phone-numbers <value>
[--name <value>]
[--expiry-minutes <value>]
--capabilities <value>
[--number-selection-behavior <value>]
[--geo-match-level <value>]
[--geo-match-params <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]

Параметры

--voice-connector-id (строка)

Идентификатор Voice Connector.

--participant-phone-numbers (список)

Телефонные номера участников.

(строка)

Синтаксис:

"string" "string" ...

--name (строка)

Название сессии прокси.

--expiry-minutes (целое число)

Количество минут, разрешённых для сессии прокси.

--capabilities (список)

Возможности сессии прокси.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Voice
  SMS

--number-selection-behavior (строка)

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

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

  • PreferSticky
  • AvoidSticky

--geo-match-level (строка)

Предпочтение сопоставления страны или кода области телефонного номера прокси с страной или кодом области первого участника.

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

  • Country
  • AreaCode

--geo-match-params (структура)

Страна и код области для телефонного номера прокси.

Страна -> (строка)

Страна.

Код области -> (строка)

Код области.

Сокращённый синтаксис:

Country=string,AreaCode=string

Синтаксис JSON:

{
  "Country": "string",
  "AreaCode": "string"
}

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

Вывод

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

Подробности о сессии прокси.

VoiceConnectorId -> (строка)

Идентификатор Voice Connector.

ProxySessionId -> (строка)

Идентификатор сессии прокси.

Имя -> (строка)

Имя сессии прокси.

Статус -> (строка)

Статус сессии прокси.

ExpiryMinutes -> (целое число)

Количество минут, разрешённых для сессии прокси.

Capabilities -> (список)

Возможности сессии прокси.

(строка)

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

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

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

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

EndedTimestamp -> (временная метка)

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

Participants -> (список)

Участники сессии прокси.

(структура)

Номер телефона и номер телефона прокси для участника в сессии прокси Amazon Chime SDK Voice Connector.

PhoneNumber -> (строка)

Номер телефона участника.

ProxyPhoneNumber -> (строка)

Номер телефона прокси участника.

NumberSelectionBehavior -> (строка)

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

GeoMatchLevel -> (строка)

Предпочтение сопоставления страны или кода области телефонного номера прокси с страной или кодом области первого участника.

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

Страна и код области для телефонного номера прокси.

Страна -> (строка)

Страна.

Код области -> (строка)

Код области.

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

Spec-Zone.ru

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