Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

describe-connectors

Описание

Описывает коннекторы, предоставляемые Amazon AppFlow, для указанных типов коннекторов. Если вы не укажете тип коннектора, эта операция опишет все коннекторы, предоставляемые Amazon AppFlow. Если коннекторов больше, чем можно вернуть на одной странице, ответ содержит объект nextToken, который можно использовать в следующем вызове операции API DescribeConnectors для получения следующей страницы.

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

Синтаксис

  describe-connectors
[--connector-types <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--connector-types (список)

Тип коннектора, например, Salesforce, Amplitude и т. д.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Salesforce
  Singular
  Slack
  Redshift
  S3
  Marketo
  Googleanalytics
  Zendesk
  Servicenow
  Datadog
  Trendmicro
  Snowflake
  Dynatrace
  Infornexus
  Amplitude
  Veeva
  EventBridge
  LookoutMetrics
  Upsolver
  Honeycode
  CustomerProfiles
  SAPOData
  CustomConnector
  Pardot

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

Максимальное количество элементов, которое должно быть возвращено в наборе результатов. По умолчанию значение равно 20.

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

Токен постраничной навигации для следующей страницы данных.

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

Вывод

connectorConfigurations -> (массив)

Конфигурация, применяемая к коннекторам, используемым в потоке.

ключ -> (строка)

значение -> (структура)

Настройки конфигурации, связанные с данным соединителем.

canUseAsSource -> (boolean)

Указывает, можно ли использовать соединитель в качестве источника.

canUseAsDestination -> (boolean)

Указывает, можно ли использовать соединитель в качестве назначения.

supportedDestinationConnectors -> (list)

Список соединителей, доступных для использования в качестве назначений.

(string)

supportedSchedulingFrequencies -> (list)

Указывает поддерживаемые частоты потоков для данного соединителя.

(string)

isPrivateLinkEnabled -> (boolean)

Указывает, включен ли PrivateLink для данного соединителя.

isPrivateLinkEndpointUrlRequired -> (boolean)

Указывает, требуется ли URL-адрес конечной точки PrivateLink.

supportedTriggerTypes -> (list)

Указывает поддерживаемые типы триггеров для потока.

(string)

connectorMetadata -> (structure)

Указывает метаданные, специфичные для соединителя, такие как oAuthScopes , supportedRegions , privateLinkServiceUrl и так далее.

Amplitude -> (structure)

Метаданные соединителя, специфичные для Amplitude.

Datadog -> (structure)

Метаданные соединителя, специфичные для Datadog.

Dynatrace -> (structure)

Метаданные соединителя, специфичные для Dynatrace.

GoogleAnalytics -> (structure)

Метаданные соединителя, специфичные для Google Analytics.

oAuthScopes -> (list)

Требуемый охват авторизации для учетной записи Google Analytics.

(string)

InforNexus -> (structure)

Метаданные соединителя, специфичные для Infor Nexus.

Marketo -> (structure)

Метаданные соединителя, специфичные для Marketo.

Redshift -> (structure)

Метаданные соединителя, специфичные для Amazon Redshift.

S3 -> (structure)

Метаданные соединителя, специфичные для Amazon S3.

Salesforce -> (structure)

Метаданные соединителя, специфичные для Salesforce.

oAuthScopes -> (list)

Требуемый охват авторизации для учетной записи Salesforce.

(string)

dataTransferApis -> (list)

API Salesforce, которые Amazon AppFlow может использовать при передаче данных в Salesforce или из Salesforce.

(string)

oauth2GrantTypesSupported -> (list)

Типы грантов OAuth 2.0, которые Amazon AppFlow может использовать при запросе токена доступа от Salesforce. Amazon AppFlow требует токен доступа каждый раз, когда пытается получить доступ к вашим записям Salesforce.

AUTHORIZATION_CODE

Amazon AppFlow передает код авторизации при запросе токена доступа от Salesforce. Amazon AppFlow получает код авторизации от Salesforce после входа в вашу учетную запись Salesforce и авторизации Amazon AppFlow для доступа к вашим записям.

JWT_BEARER

Amazon AppFlow передает JSON-токен (JWT) при запросе токена доступа от Salesforce. Вы предоставляете JWT Amazon AppFlow при определении подключения к вашей учетной записи Salesforce. При использовании этого типа гранта вам не нужно входить в вашу учетную запись Salesforce для авторизации Amazon AppFlow для доступа к вашим записям.

Примечание

Значение CLIENT_CREDENTIALS не поддерживается для Salesforce.

(string)

ServiceNow -> (structure)

Метаданные соединителя, специфичные для ServiceNow.

Singular -> (structure)

Метаданные соединителя, специфичные для Singular.

Slack -> (structure)

Метаданные соединителя, специфичные для Slack.

oAuthScopes -> (list)

Требуемый охват авторизации для учетной записи Slack.

(string)

Snowflake -> (structure)

Метаданные соединителя, специфичные для Snowflake.

supportedRegions -> (list)

Указывает поддерживаемые регионы Amazon Web Services при использовании Snowflake.

(string)

Trendmicro -> (structure)

Метаданные соединителя, специфичные для Trend Micro.

Veeva -> (structure)

Метаданные соединителя, специфичные для Veeva.

Zendesk -> (structure)

Метаданные соединителя, специфичные для Zendesk.

oAuthScopes -> (list)

Требуемый охват авторизации для учетной записи Zendesk.

(string)

EventBridge -> (structure)

Метаданные соединителя, специфичные для Amazon EventBridge.

Upsolver -> (structure)

Метаданные соединителя, специфичные для Upsolver.

CustomerProfiles -> (structure)

Метаданные соединителя, специфичные для Amazon Connect Customer Profiles.

Honeycode -> (structure)

Метаданные соединителя, специфичные для Amazon Honeycode.

oAuthScopes -> (list)

Требуемый охват авторизации для учетной записи Amazon Honeycode.

(string)

SAPOData -> (structure)

Метаданные соединителя, специфичные для SAPOData.

Pardot -> (structure)

Метаданные соединителя, специфичные для Salesforce Pardot.

connectorType -> (string)

Тип соединителя.

connectorLabel -> (string)

Метка, используемая для регистрации соединителя.

connectorDescription -> (string)

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

connectorOwner -> (string)

Разработчик соединителя.

connectorName -> (string)

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

connectorVersion -> (string)

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

connectorArn -> (string)

Amazon Resource Name (ARN) для зарегистрированного соединителя.

connectorModes -> (list)

Режимы подключения, которые поддерживает соединитель.

(string)

authenticationConfig -> (structure)

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

isBasicAuthSupported -> (boolean)

Указывает, поддерживается ли базовая аутентификация соединителем.

isApiKeyAuthSupported -> (boolean)

Указывает, поддерживается ли аутентификация с помощью ключа API соединителем.

isOAuth2Supported -> (boolean)

Указывает, поддерживается ли аутентификация OAuth 2.0 соединителем.

isCustomAuthSupported -> (boolean)

Указывает, поддерживается ли настройка аутентификации соединителем.

oAuth2Defaults -> (structure)

Содержит значения по умолчанию, необходимые для аутентификации OAuth 2.0.

oauthScopes -> (list)

Охваты OAuth 2.0, которые поддерживает соединитель.

(string)

tokenUrls -> (list)

URL-адреса токенов, которые можно использовать для аутентификации OAuth 2.0.

(string)

authCodeUrls -> (list)

URL-адреса кода авторизации, которые можно использовать для аутентификации OAuth 2.0.

(string)

oauth2GrantTypesSupported -> (list)

Поддерживаемые типы грантов OAuth 2.0 соединителем.

(string)

oauth2CustomProperties -> (list)

Список пользовательских параметров, необходимых для аутентификации OAuth 2.0.

(structure)

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

key -> (string)

Ключ пользовательского параметра, необходимый для аутентификации OAuth 2.0.

isRequired -> (boolean)

Указывает, требуется ли пользовательский параметр для аутентификации OAuth 2.0.

label -> (string)

Метка пользовательского параметра, используемого для аутентификации OAuth 2.0.

description -> (string)

Описание пользовательского параметра, используемого для аутентификации OAuth 2.0.

isSensitiveField -> (boolean)

Указывает, является ли этот параметр аутентификации конфиденциальным.

connectorSuppliedValues -> (list)

Содержит значения по умолчанию для этого параметра аутентификации, предоставляемые соединителем.

(string)

type -> (string)

Указывает, используется ли пользовательский параметр с TokenUrl или AuthUrl.

customAuthConfigs -> (list)

Содержит информацию, необходимую для пользовательской аутентификации.

(structure)

Конфигурационная информация, необходимая для пользовательской аутентификации.

customAuthenticationType -> (string)

Тип аутентификации, используемый пользовательским соединителем.

authParameters -> (list)

Информация о необходимых параметрах аутентификации.

(structure)

Информация о необходимых параметрах аутентификации.

key -> (string)

Ключ аутентификации, необходимый для аутентификации с соединителем.

isRequired -> (boolean)

Указывает, требуется ли этот параметр аутентификации.

label -> (string)

Метка, используемая для параметра аутентификации.

description -> (string)

Описание параметра аутентификации.

isSensitiveField -> (boolean)

Указывает, является ли этот параметр аутентификации конфиденциальным.

connectorSuppliedValues -> (list)

Содержит значения по умолчанию для этого параметра аутентификации, предоставляемые соединителем.

(string)

connectorRuntimeSettings -> (list)

Необходимые параметры выполнения соединителя.

(structure)

Содержит информацию о параметрах выполнения соединителя, необходимых для выполнения потока.

key -> (string)

Содержит информацию о значении параметра выполнения соединителя.

dataType -> (string)

Тип данных параметра выполнения соединителя.

isRequired -> (boolean)

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

label -> (string)

Метка, используемая для параметра выполнения соединителя.

description -> (string)

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

scope -> (string)

Указывает область применения параметра выполнения соединителя.

connectorSuppliedValueOptions -> (list)

Содержит значения по умолчанию для параметра выполнения соединителя, предоставляемые соединителем.

(string)

supportedApiVersions -> (list)

Список поддерживаемых версий API соединителя.

(string)

supportedOperators -> (list)

Список операторов, поддерживаемых соединителем.

(string)

supportedWriteOperations -> (list)

Список поддерживаемых операций записи соединителем.

(string)

Возможные операции записи в соединителе назначения. Если это значение не указано, оно по умолчанию устанавливается на операцию INSERT.

connectorProvisioningType -> (string)

Тип подготовки соединителя.

connectorProvisioningConfig -> (structure)

Настройка, необходимая для регистрации соединителя.

lambda -> (structure)

Содержит информацию о конфигурации lambda, регистрируемой как соединитель.

lambdaArn -> (string)

Lambda ARN зарегистрированного соединителя.

logoURL -> (string)

URL-адрес логотипа соединителя.

registeredAt -> (timestamp)

Дата регистрации соединителя.

registeredBy -> (string)

Информация о пользователе, зарегистрировавшем соединитель.

supportedDataTransferTypes -> (list)

Типы передачи данных, поддерживаемые соединителем.

RECORD

Структурированные записи.

FILE

Файлы или двоичные данные.

(string)

supportedDataTransferApis -> (list)

API приложения-соединителя, которые Amazon AppFlow может использовать для передачи ваших данных.

(structure)

API приложения-соединителя, которое Amazon AppFlow использует для передачи ваших данных.

Name -> (string)

Имя API приложения-соединителя.

Type -> (string)

Вы можете указать один из следующих типов:

AUTOMATIC

По умолчанию. Оптимизирует поток для наборов данных, размер которых меняется от небольшого до большого. Для каждого запуска потока Amazon AppFlow выбирает тип API SYNC или ASYNC в зависимости от объема передаваемых данных.

SYNC

Синхронный API. Этот тип API оптимизирует поток для наборов данных небольшого и среднего размера.

ASYNC

Асинхронный API. Этот тип API оптимизирует поток для больших наборов данных.

connectors -> (list)

Информация о поддерживаемых в Amazon AppFlow соединителях.

(structure)

Информация о зарегистрированном соединителе.

connectorDescription -> (string)

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

connectorName -> (string)

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

connectorOwner -> (string)

Владелец соединителя.

connectorVersion -> (string)

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

applicationType -> (string)

Тип приложения соединителя.

connectorType -> (string)

Тип соединителя.

connectorLabel -> (string)

Метка, используемая для соединителя.

registeredAt -> (timestamp)

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

registeredBy -> (string)

Пользователь, который зарегистрировал соединитель.

connectorProvisioningType -> (string)

Тип подготовки соединителя.

connectorModes -> (list)

Режим подключения, поддерживаемый соединителем.

(string)

supportedDataTransferTypes -> (list)

Типы передачи данных, поддерживаемые соединителем.

RECORD

Структурированные записи.

FILE

Файлы или двоичные данные.

(string)

nextToken -> (string)

Токен постраничной навигации для следующей страницы данных.

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

Spec-Zone.ru

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