[ aws . chime-sdk-voice ]
создать-правило-sip
Описание
Создаёт правило SIP, которое может использоваться для запуска приложения SIP-медиа в качестве целевого объекта для определённого типа триггера. Дополнительную информацию о правилах SIP см. в руководстве администратора Amazon Chime SDK (Amazon Chime SDK Administrator Guide) в разделе Управление приложениями и правилами SIP-медиа.
См. также: Документация API AWS
Синтаксис
create-sip-rule
--name <value>
--trigger-type <value>
--trigger-value <value>
[--disabled | --no-disabled]
[--target-applications <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]
Параметры
--name (строка)
--trigger-type (строка)
Тип триггера, назначенного правилу SIP в TriggerValue, в настоящее время RequestUriHostname или ToPhoneNumber.
Возможные значения:
ToPhoneNumberRequestUriHostname
--trigger-value (строка)
TriggerType равно RequestUriHostname, значение может быть именем хоста исходящего соединения Voice Connector. Если TriggerType равно ToPhoneNumber, значение может быть собственным номером телефона клиента в формате E.164. Правило SipMediaApplication, указанное в SipRule, срабатывает, если запрос URI в входящем запросе SIP соответствует RequestUriHostname, или если заголовок To в входящем запросе SIP соответствует значению ToPhoneNumber.--disabled | --no-disabled (логическое значение)
--target-applications (список)
Список приложений SIP-медиа с приоритетом и регионом AWS. Только одно приложение SIP на регион AWS может быть использовано.
(структура)
Целевое приложение SIP-медиа и другие данные, такие как приоритет и регион AWS, которые необходимо указать в правиле SIP. Только одно правило SIP на регион AWS может быть предоставлено.
SipMediaApplicationId -> (строка)
Priority -> (целое число)
AwsRegion -> (строка)
Сокращённый синтаксис:
SipMediaApplicationId=string,Priority=integer,AwsRegion=string ...
Синтаксис JSON:
[
{
"SipMediaApplicationId": "string",
"Priority": integer,
"AwsRegion": "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-auto-prompt (логическое значение)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запрос параметров входных данных CLI.
Вывод
SipRule -> (структура)
Информация о правиле SIP, включая идентификатор правила, триггеры и целевые приложения.
SipRuleId -> (строка)
Name -> (строка)
Disabled -> (логическое значение)
TriggerType -> (строка)
TriggerValue -> (строка)
TargetApplications -> (список)
Целевое приложение SIP-медиа и другие данные, такие как приоритет и регион AWS, которые необходимо указать в правиле SIP. Только одно правило SIP на регион AWS может быть предоставлено.
(структура)
Целевое приложение SIP-медиа и другие данные, такие как приоритет и регион AWS, которые необходимо указать в правиле SIP. Только одно правило SIP на регион AWS может быть предоставлено.
SipMediaApplicationId -> (строка)
Priority -> (целое число)
AwsRegion -> (строка)
CreatedTimestamp -> (временная метка)
UpdatedTimestamp -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.