Spec-Zone.ru › AWS CLI v2

[ aws . appflow ]

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 и т.д.

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

  • 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-profile-name (строка)

Имя профиля коннектора. Имя уникально для каждого ConnectorProfile в учетной записи Amazon Web Services.

--api-version (строка)

Версия API, используемая коннектором.

--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 -> (булево)

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

isUpsertable -> (булево)

Указывает, может ли запуск потока либо вставлять новые строки в поле пункта назначения, если они ещё не существуют, либо обновлять их, если они уже существуют.

isUpdatable -> (булево)

Указывает, может ли поле быть обновлено во время операции UPDATE или UPSERT записи.

isDefaultedOnCreate -> (булево)

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

supportedWriteOperations -> (список)

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

(строка)

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

customProperties -> (карта)

Карта со специфическими свойствами, относящимися к ConnectorEntityField.

key -> (строка)

value -> (строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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