создание пространства имен канала
Описание
Создаёт ChannelNamespace для Api .
См. также: Документацию API AWS
Синтаксис
create-channel-namespace
--api-id <value>
--name <value>
[--subscribe-auth-modes <value>]
[--publish-auth-modes <value>]
[--code-handlers <value>]
[--tags <value>]
[--handler-configs <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]
Параметры
--api-id (строка)
Api .--name (строка)
ChannelNamespace . Это имя должно быть уникальным в пределах Api .--subscribe-auth-modes (список)
Режим авторизации для подписки на сообщения в пространстве имен канала. Эта конфигурация переопределяет конфигурацию авторизации по умолчанию Api .
(структура)
Описание конфигурации авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для Event API.
authType -> (строка)
Упрощённый синтаксис:
authType=string ...
Синтаксис JSON:
[
{
"authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
}
...
]
--publish-auth-modes (список)
Режим авторизации для публикации сообщений в пространстве имен канала. Эта конфигурация переопределяет конфигурацию авторизации по умолчанию Api .
(структура)
Описание конфигурации авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для Event API.
authType -> (строка)
Упрощённый синтаксис:
authType=string ...
Синтаксис JSON:
[
{
"authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
}
...
]
--code-handlers (строка)
--tags (массив)
Массив с ключами типа TagKey и значениями типа TagValue .
key -> (строка)
value -> (строка)
Упрощённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--handler-configs (структура)
Конфигурация для обработчиков OnPublish и OnSubscribe .
onPublish -> (структура)
Конфигурация обработчика OnPublish .
behavior -> (строка)
integration -> (структура)
Конфигурация источника данных интеграции для обработчика.
dataSourceName -> (строка)
lambdaConfig -> (структура)
Конфигурация источника данных Lambda.
invokeType -> (строка)
onSubscribe -> (структура)
Конфигурация обработчика OnSubscribe .
behavior -> (строка)
integration -> (структура)
Конфигурация источника данных интеграции для обработчика.
dataSourceName -> (строка)
lambdaConfig -> (структура)
Конфигурация источника данных Lambda.
invokeType -> (строка)
Синтаксис JSON:
{
"onPublish": {
"behavior": "CODE"|"DIRECT",
"integration": {
"dataSourceName": "string",
"lambdaConfig": {
"invokeType": "REQUEST_RESPONSE"|"EVENT"
}
}
},
"onSubscribe": {
"behavior": "CODE"|"DIRECT",
"integration": {
"dataSourceName": "string",
"lambdaConfig": {
"invokeType": "REQUEST_RESPONSE"|"EVENT"
}
}
}
}
--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.
Вывод
channelNamespace -> (структура)
Объект ChannelNamespace .
apiId -> (строка)
Api .name -> (строка)
Api .subscribeAuthModes -> (список)
Режим авторизации для подписки на сообщения в пространстве имен канала. Эта конфигурация переопределяет конфигурацию авторизации по умолчанию Api .
(структура)
Описание конфигурации авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для Event API.
authType -> (строка)
publishAuthModes -> (список)
Режим авторизации для публикации сообщений в пространстве имен канала. Эта конфигурация переопределяет конфигурацию авторизации по умолчанию Api .
(структура)
Описание конфигурации авторизации. Используйте AuthMode для указания конфигурации авторизации публикации и подписки для Event API.
authType -> (строка)
codeHandlers -> (строка)
tags -> (массив)
Массив с ключами типа TagKey и значениями типа TagValue .
key -> (строка)
value -> (строка)
channelNamespaceArn -> (строка)
ChannelNamespace .created -> (временная метка)
ChannelNamespace .lastModified -> (временная метка)
ChannelNamespace .handlerConfigs -> (структура)
Конфигурация для обработчиков OnPublish и OnSubscribe .
onPublish -> (структура)
Конфигурация обработчика OnPublish .
behavior -> (строка)
integration -> (структура)
Конфигурация источника данных интеграции для обработчика.
dataSourceName -> (строка)
lambdaConfig -> (структура)
Конфигурация источника данных Lambda.
invokeType -> (строка)
onSubscribe -> (структура)
Конфигурация обработчика OnSubscribe .
behavior -> (строка)
integration -> (структура)
Конфигурация источника данных интеграции для обработчика.
dataSourceName -> (строка)
lambdaConfig -> (структура)
Конфигурация источника данных Lambda.
invokeType -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.