list-connector-entities
Описание
Возвращает список доступных сущностей соединителя, поддерживаемых Amazon AppFlow. Например, вы можете запросить сущности Account и Opportunity для Salesforce или сущность Incident для ServiceNow.
См. также: Документацию API AWS
Синтаксис
list-connector-entities
[--connector-profile-name <value>]
[--connector-type <value>]
[--entities-path <value>]
[--api-version <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-profile-name (строка)
ConnectorProfile в учетной записи Amazon Web Services и используется для запроса подключенного соединителя.--connector-type (строка)
Тип соединителя, например Salesforce, Amplitude и т. д.
Возможные значения:
SalesforceSingularSlackRedshiftS3MarketoGoogleanalyticsZendeskServicenowDatadogTrendmicroSnowflakeDynatraceInfornexusAmplitudeVeevaEventBridgeLookoutMetricsUpsolverHoneycodeCustomerProfilesSAPODataCustomConnectorPardot
--entities-path (строка)
entitiesPath. Если соединитель поддерживает сущности на разных корнях, этот начальный запрос возвращает список корней. В противном случае этот запрос возвращает все сущности, поддерживаемые поставщиком.--api-version (строка)
--max-results (целое число)
--next-token (строка)
ListConnectorEntities, если ответ был слишком большим для размера страницы. Вы указываете этот токен, чтобы получить следующую страницу результатов в отформатированном ответе.--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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Вывод
connectorEntityMap -> (карта)
Ответ ListConnectorEntities содержит список сущностей, сгруппированных по категориям. Ключ этой карты представляет имя группы, а ее значение содержит список сущностей, относящихся к этой группе.
ключ -> (строка)
значение -> (список)
(структура)
Высокоуровневая сущность, которую можно запросить в Amazon AppFlow. Например, сущностью Salesforce может быть Account или Opportunity, а сущностью ServiceNow — Incident.
name -> (строка)
label -> (строка)
hasNestedEntities -> (логическое значение)
entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", он вернет вложенные сущности под ней. Это позволяет рекурсивно получить все поддерживаемые сущности.nextToken -> (строка)
ListConnectorEntities, чтобы получить следующую страницу результатов в отформатированном ответе. Операция ListConnectorEntities предоставляет этот токен, если ответ слишком большой для размера страницы.
© Copyright 2025, Amazon Web Services. Created using Sphinx.