Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

get-channel-namespace

Описание

Извлекает имя пространства каналов для указанного Api.

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

Синтаксис

  get-channel-namespace
--api-id <value>
--name <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.

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

Вывод

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