Spec-Zone.ru › AWS CLI v2

[ aws . kafkaconnect ]

list-connectors

Описание

Возвращает список всех коннекторов в данной учетной записи и регионе. Список ограничен коннекторами, имя которых начинается с указанного префикса. Ответ также включает описание каждого из перечисленных коннекторов.

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

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

Синтаксис

  list-connectors
[--connector-name-prefix <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]

Параметры

--connector-name-prefix (строка)

Префикс имени, который вы хотите использовать для поиска и перечисления коннекторов.

--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 (целое число)

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

Вывод

connectors -> (список)

Массив описаний соединителей.

(структура)

Сводка соединителя.

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

Настройки вычислительной мощности соединителя.

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

Описание автоматического масштабирования соединителя.

maxWorkerCount -> (целое число)

Максимальное количество рабочих процессов, выделенных для соединителя.

mcuCount -> (целое число)

Количество микроконтроллерных блоков (MCU), выделенных для каждого рабочего процесса соединителя. Допустимые значения: 1, 2, 4, 8.

minWorkerCount -> (целое число)

Минимальное количество рабочих процессов, выделенных для соединителя.

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

Политика уменьшения масштаба для соединителя.

cpuUtilizationPercentage -> (целое число)

Указывает порог использования ЦП (в процентах), при котором произойдёт уменьшение масштаба соединителя.

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

Политика увеличения масштаба для соединителя.

cpuUtilizationPercentage -> (целое число)

Порог использования ЦП (в процентах), при котором произойдёт увеличение масштаба соединителя.

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

Описание выделенной мощности соединителя.

mcuCount -> (целое число)

Количество микроконтроллерных блоков (MCU), выделенных для каждого рабочего процесса соединителя. Допустимые значения: 1, 2, 4, 8.

workerCount -> (целое число)

Количество рабочих процессов, выделенных для соединителя.

connectorArn -> (строка)

Идентификатор ресурса Amazon (ARN) соединителя.

connectorDescription -> (строка)

Описание соединителя.

connectorName -> (строка)

Имя соединителя.

connectorState -> (строка)

Состояние соединителя.

creationTime -> (метка времени)

Время создания соединителя.

currentVersion -> (строка)

Текущая версия соединителя.

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

Детали кластера Apache Kafka, к которому подключен соединитель.

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

Кластер Apache Kafka, к которому подключен соединитель.

bootstrapServers -> (строка)

Bootstrap-серверы кластера.

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

Детали Amazon VPC с сетевым подключением к кластеру Apache Kafka.

securityGroups -> (список)

Группы безопасности для соединителя.

(строка)

subnets -> (список)

Подсети для соединителя.

(строка)

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

Тип аутентификации клиента, используемый для подключения к кластеру Apache Kafka. Значение NONE означает, что аутентификация клиента не используется.

authenticationType -> (строка)

Тип аутентификации клиента, используемый для подключения к кластеру Apache Kafka. Значение NONE означает, что аутентификация клиента не используется.

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

Детали шифрования в процессе передачи в кластер Apache Kafka.

encryptionType -> (строка)

Тип шифрования в процессе передачи в кластер Apache Kafka.

kafkaConnectVersion -> (строка)

Версия Kafka Connect. Она должна быть совместима как с версией кластера Apache Kafka, так и с плагинами.

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

Настройки для передачи логов соединителя в Amazon CloudWatch Logs.

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

Рабочие процессы могут отправлять журналы в различные типы целевых систем. Данная настройка задаёт детали этих целевых систем.

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

Информация о передаче журналов в Amazon CloudWatch Logs.

enabled -> (булево)

Включена ли передача логов в Amazon CloudWatch Logs.

logGroup -> (строка)

Название группы журналов CloudWatch, являющейся целью для передачи журналов.

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

Информация о передаче логов в Amazon Kinesis Data Firehose.

deliveryStream -> (строка)

Имя потока доставки Kinesis Data Firehose, являющегося целью для передачи логов.

enabled -> (булево)

Включено ли направление журналов соединителя в Amazon Kinesis Data Firehose.

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

Информация о передаче логов в Amazon S3.

bucket -> (строка)

Имя ведра S3, являющегося целью для передачи логов.

enabled -> (булево)

Включена ли отправка журналов соединителя в указанную целевую систему Amazon S3.

prefix -> (строка)

Префикс S3, являющийся целью для передачи логов.

plugins -> (список)

Указывает, какие плагины были использованы для этого соединителя.

(структура)

Описание плагина.

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

Подробности о пользовательском плагине.

customPluginArn -> (строка)

Идентификатор ресурса Amazon (ARN) пользовательского плагина.

revision -> (длинное целое число)

Ревизия пользовательского плагина.

serviceExecutionRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, используемой соединителем для доступа к ресурсам Amazon Web Services.

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

Настройки рабочих процессов, используемые с соединителем.

revision -> (длинное целое число)

Ревизия конфигурации рабочих процессов.

workerConfigurationArn -> (строка)

Идентификатор ресурса Amazon (ARN) конфигурации рабочих процессов.

nextToken -> (строка)

Если ответ операции ListConnectors усечён, он будет содержать NextToken. Передайте этот NextToken в последующем запросе, чтобы продолжить перечисление с того места, где остановились.

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

Spec-Zone.ru

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