Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

list-channel-namespaces

Описание

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

ListChannelNamespaces возвращает только общие сведения о пространстве имен канала. Для получения обработчиков кода используйте GetChannelNamespace.

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

list-channel-namespaces — это операция с постраничной обработкой. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: channelNamespaces

Синтаксис

  list-channel-namespaces
--api-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в формате JSON. Передавать произвольные двоичные значения с помощью значения, предоставленного в формате JSON, невозможно, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-службы.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды будет предоставлено значение NextToken. Для возобновления постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

channelNamespaces -> (список)

Объекты ChannelNamespace.

(структура)

Описание пространства имен канала, связанного с Api. ChannelNamespace содержит определения обработчиков кода для Api.

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.

nextToken -> (строка)

Идентификатор, возвращённый предыдущим вызовом этой операции, который можно использовать для возврата следующего набора элементов в списке.

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

Spec-Zone.ru

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