Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

обновить-пространство-имен-канала

Описание

Обновляет ChannelNamespace, связанный с Api.

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

Синтаксис

  update-channel-namespace
--api-id <value>
--name <value>
[--subscribe-auth-modes <value>]
[--publish-auth-modes <value>]
[--code-handlers <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.

--subscribe-auth-modes (список)

Режим авторизации для подписки на сообщения в пространстве имен канала. Эта настройка переопределяет стандартную конфигурацию авторизации Api.

(структура)

Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации для публикации и подписки на API событий.

authType -> (строка)

Тип авторизации.

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

authType=string ...

Синтаксис JSON:

[
  {
    "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
  }
  ...
]

--publish-auth-modes (список)

Режим авторизации для публикации сообщений в пространстве имен канала. Эта настройка переопределяет стандартную конфигурацию авторизации Api.

(структура)

Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации для публикации и подписки на API событий.

authType -> (строка)

Тип авторизации.

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

authType=string ...

Синтаксис JSON:

[
  {
    "authType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|"AWS_LAMBDA"
  }
  ...
]

--code-handlers (строка)

Функции обработчиков событий, выполняющие пользовательскую бизнес-логику для обработки опубликованных событий и запросов подписки.

--handler-configs (структура)

Конфигурация обработчиков OnPublish и OnSubscribe.

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

Конфигурация обработчика OnPublish.

behavior -> (строка)

Поведение обработчика.

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

Конфигурация источника интеграции данных для обработчика.

dataSourceName -> (строка)

Уникальное имя источника данных, настроенного в API.

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

Конфигурация источника данных Lambda.

invokeType -> (строка)

Тип вызова для источника данных Lambda.

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

Конфигурация обработчика OnSubscribe.

behavior -> (строка)

Поведение обработчика.

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

Конфигурация источника интеграции данных для обработчика.

dataSourceName -> (строка)

Уникальное имя источника данных, настроенного в API.

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

Конфигурация источника данных Lambda.

invokeType -> (строка)

Тип вызова для источника данных Lambda.

Синтаксис 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 для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

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

Объект ChannelNamespace.

apiId -> (строка)

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

name -> (строка)

Имя пространства имен канала. Это имя должно быть уникальным в пределах Api.

subscribeAuthModes -> (список)

Режим авторизации для подписки на сообщения в пространстве имен канала. Эта настройка переопределяет стандартную конфигурацию авторизации Api.

(структура)

Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации для публикации и подписки на API событий.

authType -> (строка)

Тип авторизации.

publishAuthModes -> (список)

Режим авторизации для публикации сообщений в пространстве имен канала. Эта настройка переопределяет стандартную конфигурацию авторизации Api.

(структура)

Описывает конфигурацию авторизации. Используйте AuthMode для указания конфигурации авторизации для публикации и подписки на API событий.

authType -> (строка)

Тип авторизации.

codeHandlers -> (строка)

Функции обработчиков событий, выполняющие пользовательскую бизнес-логику для обработки опубликованных событий и запросов подписки.

tags -> (карта)

Карта с ключами TagKey и значениями TagValue.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

channelNamespaceArn -> (строка)

Amazon Resource Name (ARN) для ChannelNamespace.

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

Дата и время создания ChannelNamespace.

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

Дата и время последнего изменения ChannelNamespace.

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

Конфигурация обработчиков OnPublish и OnSubscribe.

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

Конфигурация обработчика OnPublish.

behavior -> (строка)

Поведение обработчика.

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

Конфигурация источника интеграции данных для обработчика.

dataSourceName -> (строка)

Уникальное имя источника данных, настроенного в API.

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

Конфигурация источника данных Lambda.

invokeType -> (строка)

Тип вызова для источника данных Lambda.

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

Конфигурация обработчика OnSubscribe.

behavior -> (строка)

Поведение обработчика.

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

Конфигурация источника интеграции данных для обработчика.

dataSourceName -> (строка)

Уникальное имя источника данных, настроенного в API.

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

Конфигурация источника данных Lambda.

invokeType -> (строка)

Тип вызова для источника данных Lambda.

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

Spec-Zone.ru

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