Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

describe-connector

Описание

Описывает заданный пользовательский соединитель, зарегистрированный в вашей учетной записи Amazon Web Services. Этот API можно использовать для пользовательских соединителей, зарегистрированных в вашей учетной записи, а также для соединителей, созданных Amazon.

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

Синтаксис

  describe-connector
--connector-type <value>
[--connector-label <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-type (строка)

Тип соединителя, например CUSTOMCONNECTOR, Saleforce, Marketo. Для пользовательских соединителей на основе Lambda выберите CUSTOMCONNECTOR.

Возможные значения:

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

--connector-label (строка)

Метка соединителя. Метка уникальна для каждого ConnectorRegistration в вашей учетной записи Amazon Web Services. Требуется только при вызове для типа соединителя CUSTOMCONNECTOR.

--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
  • таблица
  • 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.

Вывод

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

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

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)

ARN lambda соединителя, который регистрируется.

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 оптимизирует поток для больших наборов данных.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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