describe-connector-entity
Описание
Предоставляет подробную информацию об сущности, используемой с коннектором, включая описание модели данных для каждого поля в этой сущности.
См. также: Документацию API AWS
Синтаксис
describe-connector-entity
--connector-entity-name <value>
[--connector-type <value>]
[--connector-profile-name <value>]
[--api-version <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-entity-name (строка)
--connector-type (строка)
Тип приложения коннектора, например Salesforce, Amplitude и т.д.
Возможные значения:
SalesforceSingularSlackRedshiftS3MarketoGoogleanalyticsZendeskServicenowDatadogTrendmicroSnowflakeDynatraceInfornexusAmplitudeVeevaEventBridgeLookoutMetricsUpsolverHoneycodeCustomerProfilesSAPODataCustomConnectorPardot
--connector-profile-name (строка)
ConnectorProfile в учетной записи Amazon Web Services.--api-version (строка)
--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 (boolean)
Включить отладочную запись.
--endpoint-url (string)
Переопределить URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определенный профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическую запрос параметров ввода CLI.
Вывод
connectorEntityFields -> (список)
Описывает поля для сущности этого коннектора. Например, для сущности аккаунт полями будут название аккаунта, идентификатор аккаунта и так далее.
(структура)
Описывает модель данных поля коннектора. Например, для сущности аккаунт полями будут название аккаунта, идентификатор аккаунта и так далее.
identifier -> (строка)
parentIdentifier -> (строка)
label -> (строка)
isPrimaryKey -> (булево)
defaultValue -> (строка)
isDeprecated -> (булево)
supportedFieldTypeDetails -> (структура)
Содержит данные о поддерживаемых FieldType, включая соответствующие filterOperators и supportedValues.
v1 -> (структура)
Начальная поддерживаемая версия для fieldType. Если позже она изменится на другую версию, будет представлена v2.
fieldType -> (строка)
filterOperators -> (список)
Список операторов, поддерживаемых полем.
(строка)
supportedValues -> (список)
Список значений, которые может содержать поле. Например, булевое fieldType может иметь два значения: “true” и “false”.
(строка)
valueRegexPattern -> (строка)
supportedDateFormat -> (строка)
fieldValueRange -> (структура)
Диапазон значений, которые может содержать это поле.
maximum -> (двойное)
minimum -> (двойное)
fieldLengthRange -> (структура)
Это диапазон допустимых длин значений этого поля.
maximum -> (двойное)
minimum -> (двойное)
description -> (строка)
sourceProperties -> (структура)
Свойства, которые могут быть применены к полю, когда коннектор используется в качестве источника.
isRetrievable -> (булево)
isQueryable -> (булево)
isTimestampFieldForIncrementalQueries -> (булево)
destinationProperties -> (структура)
Свойства, применяемые к полю, когда коннектор используется в качестве пункта назначения.
isCreatable -> (булево)
isNullable -> (булево)
isUpsertable -> (булево)
isUpdatable -> (булево)
UPDATE или UPSERT записи.isDefaultedOnCreate -> (булево)
supportedWriteOperations -> (список)
Список поддерживаемых операций записи. Для каждой перечисленной операции записи это поле может быть использовано в idFieldNames, если эта операция присутствует как опция пункта назначения.
(строка)
INSERT.customProperties -> (карта)
Карта со специфическими свойствами, относящимися к ConnectorEntityField.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.