describe-flow

Описание

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

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

Синтаксис

  describe-flow
--flow-name <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]

Параметры

--flow-name (строка)

Указанное имя потока. Пробелы запрещены. Используйте только подчёркивания (_) или дефисы (-).

--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
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из вашего файла ключей.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

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

Вывод

flowArn -> (строка)

Идентификатор ресурса Amazon (ARN) потока.

description -> (строка)

Описание потока.

flowName -> (строка)

Указанное имя потока. Пробелы запрещены. Используйте только подчёркивания (_) или дефисы (-).

kmsArn -> (строка)

ARN (идентификатор ресурса Amazon) ключа управления ключами (KMS), который вы предоставляете для шифрования. Это обязательно, если вы не хотите использовать управляемый Amazon AppFlow ключ KMS. Если вы ничего не укажете, Amazon AppFlow будет использовать управляемый Amazon AppFlow ключ KMS.

flowStatus -> (строка)

Указывает текущий статус потока.

flowStatusMessage -> (строка)

Содержит сообщение об ошибке, если статус потока приостановлен или содержит ошибку. Это относится только к запланированным или инициируемым событиями потокам.

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

Конфигурация, определяющая, как Amazon AppFlow извлекает данные из исходного коннектора.

connectorType -> (строка)

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

apiVersion -> (строка)

Версия API коннектора, когда он используется в качестве источника в потоке.

connectorProfileName -> (строка)

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

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

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

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

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

object -> (строка)

Объект, указанный в исходном потоке Amplitude.

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

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

object -> (строка)

Объект, указанный в исходном потоке Datadog.

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

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

object -> (строка)

Объект, указанный в исходном потоке Dynatrace.

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

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

object -> (строка)

Объект, указанный в исходном потоке Google Analytics.

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

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

object -> (строка)

Объект, указанный в исходном потоке Infor Nexus.

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

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

object -> (строка)

Объект, указанный в исходном потоке Marketo.

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

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

bucketName -> (строка)

Имя ведра Amazon S3, где хранятся исходные файлы.

bucketPrefix -> (строка)

Ключ объекта для ведра Amazon S3, в котором хранятся исходные файлы.

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

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

s3InputFileType -> (строка)

Тип файла, который Amazon AppFlow получает из вашего ведра Amazon S3.

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

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

object -> (строка)

Объект, указанный в исходном потоке Salesforce.

enableDynamicFieldUpdate -> (булево)

Флаг, который включает динамическое получение новых (недавно добавленных) полей в объектах Salesforce во время выполнения потока.

includeDeletedRecords -> (булево)

Указывает, включает ли Amazon AppFlow удалённые файлы в выполнение потока.

dataTransferApi -> (строка)

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

AUTOMATIC

По умолчанию. Amazon AppFlow выбирает API для использования на основе количества записей, которые ваш поток передаёт из Salesforce. Если ваш поток передаёт менее 1 000 000 записей, Amazon AppFlow использует Salesforce REST API. Если ваш поток передаёт 1 000 000 или более записей, Amazon AppFlow использует Salesforce Bulk API 2.0.

Каждый из этих API Salesforce структурирует данные по-разному. Если Amazon AppFlow выбирает API автоматически, имейте в виду, что для повторяющихся потоков выходные данные могут отличаться от одного запуска к другому. Например, если поток запускается ежедневно, он может использовать REST API в один день для передачи 900 000 записей, а на следующий день — Bulk API 2.0 для передачи 1 100 000 записей. Для каждого из этих запусков потока соответствующий API Salesforce форматирует данные по-разному. Некоторые различия включают в себя форматирование дат и представление нулевых значений. Кроме того, Bulk API 2.0 не передает составные поля Salesforce.

Выбрав этот вариант, вы оптимизируете производительность потока для передачи как небольших, так и больших наборов данных, но компромиссом является несогласованное форматирование на выходе.

BULKV2

Amazon AppFlow использует только Salesforce Bulk API 2.0. Этот API выполняет асинхронные передачи данных и оптимален для больших наборов данных. Выбрав этот вариант, вы обеспечиваете согласованный вывод вашего потока, но оптимизируете производительность только для больших наборов данных.

Обратите внимание, что Bulk API 2.0 не передает составные поля Salesforce.

REST_SYNC

Amazon AppFlow использует только Salesforce REST API. Выбрав этот вариант, вы гарантируете согласованный вывод потока, но снижаете производительность при передаче больших наборов данных, которые лучше подходят для Bulk API 2.0. В некоторых случаях, если ваш поток пытается передать очень большой набор данных, он может завершиться ошибкой с временным выходом из строя.

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

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

object -> (строка)

Объект, указанный в исходном потоке ServiceNow.

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

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

object -> (строка)

Объект, указанный в исходном потоке Singular.

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

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

object -> (строка)

Объект, указанный в исходном потоке Slack.

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

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

object -> (строка)

Объект, указанный в исходном потоке Trend Micro.

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

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

object -> (строка)

Объект, указанный в исходном потоке Veeva.

documentType -> (строка)

Тип документа, указанный в потоке извлечения документов Veeva.

includeSourceFiles -> (булево)

Булево значение для включения исходных файлов в поток извлечения документов Veeva.

includeRenditions -> (булево)

Булево значение для включения версий файла в поток извлечения документов Veeva.

includeAllVersions -> (булево)

Булево значение для включения всех версий файлов в поток извлечения документов Veeva.

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

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

object -> (строка)

Объект, указанный в исходном потоке Zendesk.

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

Свойства, которые применяются при использовании SAPOData в качестве источника потока.

objectPath -> (строка)

Путь к объекту, указанный в исходном потоке SAPOData.

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

Устанавливает количество одновременных процессов, которые передают записи OData из вашего экземпляра SAP.

maxParallelism -> (целое число)

Максимальное количество процессов, которые Amazon AppFlow запускает одновременно при извлечении данных из вашего приложения SAP.

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

Устанавливает размер страницы для каждого одновременного процесса, передающего записи OData из вашего экземпляра SAP.

maxPageSize -> (целое число)

Максимальное количество записей, которые Amazon AppFlow получает на каждой странице ответа от вашего приложения SAP. Для передачи записей OData максимальный размер страницы составляет 3000. Для передачи данных, поступающих от поставщика ODP, максимальный размер страницы составляет 10 000.

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

Свойства, применяемые при использовании пользовательского коннектора в качестве источника.

entityName -> (строка)

Сущность, указанная в пользовательском коннекторе в качестве источника в потоке.

customProperties -> (карта)

Пользовательские свойства, необходимые для использования пользовательского коннектора в качестве источника.

key -> (строка)

value -> (строка)

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

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

Name -> (строка)

Имя API приложения коннектора.

Type -> (строка)

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

AUTOMATIC

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

SYNC

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

ASYNC

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

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

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

object -> (строка)

Объект, указанный в исходном потоке Pardot Salesforce.

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

Определяет конфигурацию для запланированного инкрементального извлечения данных. Если предоставлена допустимая конфигурация, используемые поля определяются в конфигурации при запросе инкрементальных данных.

datetimeTypeFieldName -> (строка)

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

destinationFlowConfigList -> (список)

Настройка, определяющая, как Amazon AppFlow передает данные в соединитель назначения.

(структура)

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

connectorType -> (строка)

Тип соединителя, например, Salesforce, Amplitude и т. д.

apiVersion -> (строка)

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

connectorProfileName -> (строка)

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

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

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

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

Свойства, необходимые для запроса Amazon Redshift.

object -> (строка)

Объект, указанный в пункте назначения потока Amazon Redshift.

intermediateBucketName -> (строка)

Временный бакет, который Amazon AppFlow использует при перемещении данных в Amazon Redshift.

bucketPrefix -> (строка)

Ключ объекта в бакете, в который Amazon AppFlow помещает файлы назначения.

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

Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения Amazon Redshift. Например, эта настройка определяет, следует ли потоку прерваться после первой ошибки вставки или продолжить и попытаться вставить каждый запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей соединителя назначения.

failOnFirstDestinationError -> (булево)

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

bucketPrefix -> (строка)

Указывает префикс для Amazon S3-бакета.

bucketName -> (строка)

Указывает имя Amazon S3-бакета.

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

Свойства, необходимые для запроса Amazon S3.

bucketName -> (строка)

Имя Amazon S3-бакета, в который Amazon AppFlow помещает передаваемые данные.

bucketPrefix -> (строка)

Ключ объекта для целевого бакета, в который Amazon AppFlow помещает файлы.

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

Конфигурация, определяющая, как Amazon AppFlow должен форматировать выходные данные потока при использовании Amazon S3 в качестве пункта назначения.

fileType -> (строка)

Указывает тип файла, который Amazon AppFlow помещает в Amazon S3-бакем.

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

Определяет префикс, который Amazon AppFlow применяет к имени папки в Amazon S3-бакете. Вы можете называть папки в соответствии с частотой потока и датой.

prefixType -> (строка)

Определяет формат префикса и то, относится ли он к имени файла, пути к файлу или к обоим.

prefixFormat -> (строка)

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

pathPrefixHierarchy -> (список)

Указывает, включает ли путь к целевому файлу следующие элементы:

EXECUTION_ID

Идентификатор, который Amazon AppFlow присваивает запуску потока.

SCHEMA_VERSION

Номер версии вашей схемы данных. Amazon AppFlow присваивает этот номер версии. Номер версии увеличивается на единицу при изменении любых настроек конфигурации потока:

Сопоставления полей источника и назначения
Типы данных полей
Ключи разбиения

(строка)

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

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

aggregationType -> (строка)

Указывает, агрегирует ли Amazon AppFlow записи потока в один файл или оставляет их не агрегированными.

targetFileSize -> (целое число)

Желаемый размер файла в МБ для каждого выходного файла, который Amazon AppFlow записывает в пункт назначения потока. Для каждого файла Amazon AppFlow пытается достичь указанного размера. Фактические размеры файлов могут отличаться от этого целевого значения в зависимости от количества и размера записей, содержащихся в каждом файле.

preserveSourceDataTyping -> (булево)

Если формат выходного файла — Parquet, используйте этот параметр, чтобы установить, сохраняет ли Amazon AppFlow типы данных в исходных данных при записи выходных данных в Amazon S3.

true : Amazon AppFlow сохраняет типы данных при записи в Amazon S3. Например, целое число или 1 в ваших исходных данных по-прежнему будут целыми числами на выходе.
false : Amazon AppFlow преобразует все исходные данные в строки при записи в Amazon S3. Например, целое число 1 в ваших исходных данных станет строкой "1" на выходе.

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

Свойства, необходимые для запроса Salesforce.

object -> (строка)

Объект, указанный в пункте назначения потока Salesforce.

idFieldNames -> (список)

Имя поля, которое Amazon AppFlow использует в качестве идентификатора при выполнении операции записи, такой как обновление или удаление.

(строка)

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

Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения Salesforce. Например, эта настройка определяет, следует ли потоку прерваться после первой ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей соединителя назначения.

failOnFirstDestinationError -> (булево)

bucketPrefix -> (строка)

Указывает префикс для Amazon S3-бакета.

bucketName -> (строка)

Указывает имя Amazon S3-бакета.

writeOperationType -> (строка)

Это указывает тип операции записи, которая должна быть выполнена в Salesforce. Когда значение равно UPSERT, то idFieldNames является обязательным.

dataTransferApi -> (строка)

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

AUTOMATIC

По умолчанию. Amazon AppFlow выбирает API для использования на основе количества записей, которые ваш поток передает в Salesforce. Если ваш поток передает менее 1000 записей, Amazon AppFlow использует REST API Salesforce. Если ваш поток передает 1000 или более записей, Amazon AppFlow использует Bulk API 2.0 Salesforce.

Структура данных в этих API Salesforce различна. Если Amazon AppFlow выбирает API автоматически, имейте в виду, что для повторяющихся потоков выходные данные могут различаться от одного запуска потока к другому. Например, если поток запускается ежедневно, он может использовать REST API в один день для передачи 900 записей, а на следующий день может использовать Bulk API 2.0 для передачи 1100 записей. Для каждого из этих запусков потока соответствующий API Salesforce форматирует данные по-разному. Некоторые различия включают способ форматирования дат и представление пустых значений. Кроме того, Bulk API 2.0 не передает составные поля Salesforce.

Выбрав этот параметр, вы оптимизируете производительность потока как для небольших, так и для больших объемов данных, но компромисс заключается в непостоянном форматировании на выходе.

BULKV2

Amazon AppFlow использует только Salesforce Bulk API 2.0. Этот API выполняет асинхронные передачи данных и оптимален для больших наборов данных. Выбрав этот параметр, вы обеспечиваете, что ваш поток записывает согласованные выходные данные, но оптимизируете производительность только для больших объемов данных.

Обратите внимание, что Bulk API 2.0 не передает составные поля Salesforce.

REST_SYNC

Amazon AppFlow использует только REST API Salesforce. Выбрав этот параметр, вы обеспечиваете, что ваш поток записывает согласованные выходные данные, но снижаете производительность для больших объемов данных, которые лучше подходят для Bulk API 2.0. В некоторых случаях, если ваш поток пытается передать очень большой объем данных, он может завершиться ошибкой таймаута.

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

Свойства, необходимые для запроса Snowflake.

object -> (строка)

Объект, указанный в пункте назначения потока Snowflake.

intermediateBucketName -> (строка)

Временный бакет, который Amazon AppFlow использует при перемещении данных в Snowflake.

bucketPrefix -> (строка)

Ключ объекта для целевого бакета, в который Amazon AppFlow помещает файлы.

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

Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения Snowflake. Например, эта настройка определяет, следует ли потоку прерваться после первой ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей соединителя назначения.

failOnFirstDestinationError -> (булево)

bucketPrefix -> (строка)

Указывает префикс для Amazon S3-бакета.

bucketName -> (строка)

Указывает имя Amazon S3-бакета.

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

Свойства, необходимые для запроса Amazon EventBridge.

object -> (строка)

Объект, указанный в пункте назначения потока Amazon EventBridge.

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

Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения. Например, эта настройка определяет, следует ли потоку прерваться после первой ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей соединителя назначения.

failOnFirstDestinationError -> (булево)

bucketPrefix -> (строка)

Указывает префикс для Amazon S3-бакета.

bucketName -> (строка)

Указывает имя Amazon S3-бакета.

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

Свойства, необходимые для запроса Amazon Lookout for Metrics.

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

Свойства, необходимые для запроса Upsolver.

bucketName -> (строка)

Имя хранилища Upsolver Amazon S3, в которое Amazon AppFlow помещает передаваемые данные.

bucketPrefix -> (строка)

Ключ объекта в целевом хранилище Upsolver Amazon S3, в которое Amazon AppFlow помещает файлы.

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

Настройка, определяющая, как данные форматируются при использовании Upsolver в качестве целевого объекта потока.

fileType -> (строка)

Указывает тип файла, который Amazon AppFlow помещает в хранилище Upsolver Amazon S3.

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

Определяет элементы, которые Amazon AppFlow включает в имена файлов и папок в целевом объекте потока.

prefixType -> (строка)

Определяет формат префикса и относится ли он к имени файла, пути к файлу или к обоим.

prefixFormat -> (строка)

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

pathPrefixHierarchy -> (список)

Указывает, содержит ли путь к целевому файлу следующие элементы:

EXECUTION_ID

Идентификатор, присваиваемый Amazon AppFlow выполнению потока.

SCHEMA_VERSION

Номер версии схемы данных. Amazon AppFlow присваивает этот номер версии. Номер версии увеличивается на единицу при изменении следующих параметров в конфигурации потока:

Сопоставления полей «Источник—Цель»
Типы данных полей
Ключи разбиения

(строка)

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

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

aggregationType -> (строка)

Указывает, агрегирует ли Amazon AppFlow записи потока в один файл или оставляет их не агрегированными.

targetFileSize -> (длинное целое)

Желаемый размер файла в МБ для каждого выходного файла, который Amazon AppFlow записывает в целевой объект потока. Для каждого файла Amazon AppFlow пытается достичь указанного размера. Фактические размеры файлов могут отличаться от целевого значения в зависимости от количества и размера записей в каждом файле.

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

Свойства, необходимые для запроса Amazon Honeycode.

object -> (строка)

Объект, указанный в целевом объекте потока Amazon Honeycode.

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

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

failOnFirstDestinationError -> (булево)

Указывает, должен ли поток завершиться после первой ошибки при попытке размещения данных в целевом объекте.

bucketPrefix -> (строка)

Указывает префикс хранилища Amazon S3.

bucketName -> (строка)

Указывает имя хранилища Amazon S3.

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

Свойства, необходимые для запроса Amazon Connect Customer Profiles.

domainName -> (строка)

Уникальное имя домена Amazon Connect Customer Profiles.

objectTypeName -> (строка)

Объект, указанный в целевом объекте потока Amazon Connect Customer Profiles.

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

Свойства, необходимые для запроса Zendesk.

object -> (строка)

Объект, указанный в целевом объекте потока Zendesk.

idFieldNames -> (список)

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

(строка)

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

failOnFirstDestinationError -> (булево)

Указывает, должен ли поток завершиться после первой ошибки при попытке размещения данных в целевом объекте.

bucketPrefix -> (строка)

Указывает префикс хранилища Amazon S3.

bucketName -> (строка)

Указывает имя хранилища Amazon S3.

writeOperationType -> (строка)

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

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

Свойства, необходимые для запроса Marketo.

object -> (строка)

Объект, указанный в целевом объекте потока Marketo.

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

failOnFirstDestinationError -> (булево)

Указывает, должен ли поток завершиться после первой ошибки при попытке размещения данных в целевом объекте.

bucketPrefix -> (строка)

Указывает префикс хранилища Amazon S3.

bucketName -> (строка)

Указывает имя хранилища Amazon S3.

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

Свойства, необходимые для запроса пользовательского подключения.

entityName -> (строка)

Сущность, указанная в пользовательском подключении в качестве целевого объекта в потоке.

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

Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пользовательском подключении в качестве целевого объекта.

failOnFirstDestinationError -> (булево)

Указывает, должен ли поток завершиться после первой ошибки при попытке размещения данных в целевом объекте.

bucketPrefix -> (строка)

Указывает префикс хранилища Amazon S3.

bucketName -> (строка)

Указывает имя хранилища Amazon S3.

writeOperationType -> (строка)

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

idFieldNames -> (список)

Имя поля, которое Amazon AppFlow использует в качестве идентификатора при выполнении операции записи, такой как обновление, удаление или обновление.

(строка)

customProperties -> (карта)

Дополнительные свойства, специфичные для подключения, когда оно используется в качестве целевого объекта в потоке.

key -> (строка)

value -> (строка)

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

Свойства, необходимые для запроса SAPOData.

objectPath -> (строка)

Путь к объекту, указанный в целевом объекте потока SAPOData.

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

Определяет, как Amazon AppFlow обрабатывает успешный ответ, полученный от подключения после размещения данных.

Например, эта настройка определит, куда записывать ответ от подключения к целевому объекту после успешной операции вставки.

bucketPrefix -> (строка)

Префикс хранилища Amazon S3.

bucketName -> (строка)

Имя хранилища Amazon S3.

idFieldNames -> (список)

(строка)

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

failOnFirstDestinationError -> (булево)

Указывает, должен ли поток завершиться после первой ошибки при попытке размещения данных в целевом объекте.

bucketPrefix -> (строка)

Указывает префикс хранилища Amazon S3.

bucketName -> (строка)

Указывает имя хранилища Amazon S3.

writeOperationType -> (строка)

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

Описание деталей последнего выполнения потока.

mostRecentExecutionMessage -> (строка)

Описание деталей последнего выполнения потока.

mostRecentExecutionTime -> (метка времени)

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

mostRecentExecutionStatus -> (строка)

Указывает статус последнего выполнения потока.

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

Настройки триггера, определяющие, как и когда выполняется поток.

triggerType -> (строка)

Указывает тип триггера потока. Это может быть OnDemand , Scheduled или Event .

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

Определяет детали конфигурации потока, запускаемого по расписанию, как задано пользователем. В настоящее время эти настройки применяются только к типу триггера Scheduled .

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

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

scheduleExpression -> (строка)

Выражение расписания, определяющее частоту выполнения расписания, например rate(5minutes) .

dataPullMode -> (строка)

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

scheduleStartTime -> (временная метка)

Время запуска запланированного потока. Время отформатировано как временная метка, которая соответствует стандарту ISO 8601, например 2022-04-26T13:00:00-07:00 .

scheduleEndTime -> (временная метка)

Время завершения запланированного потока. Время отформатировано как временная метка, которая соответствует стандарту ISO 8601, например 2022-04-27T13:00:00-07:00 .

timezone -> (строка)

Указывает часовой пояс, используемый при указании дат и времени запланированного потока, например America/New_York . Этот часовой пояс является только описательной меткой. Он не влияет на то, как Amazon AppFlow интерпретирует временные метки, которые вы указываете для планирования потока.

Если вы хотите запланировать поток, используя время в определенном часовом поясе, укажите часовой пояс как смещение от UTC в своих временных метках. Например, смещения от UTC для часового пояса America/New_York составляют -04:00 EDT и -05:00 EST .

scheduleOffset -> (целое число)

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

firstExecutionFrom -> (временная метка)

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

flowErrorDeactivationThreshold -> (целое число)

Определяет, сколько раз запланированный поток терпит неудачу подряд, прежде чем Amazon AppFlow деактивирует его.

tasks -> (список)

Список задач, которые Amazon AppFlow выполняет при передаче данных во время запуска потока.

(структура)

Класс для моделирования различных типов задач. Реализация задач варьируется в зависимости от TaskType .

sourceFields -> (список)

Поля источника, к которым применяется конкретная задача.

(строка)

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

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

Amplitude -> (строка)

Операция, выполняемая над предоставленными полями источника Amplitude.

Datadog -> (строка)

Операция, выполняемая над предоставленными полями источника Datadog.

Dynatrace -> (строка)

Операция, выполняемая над предоставленными полями источника Dynatrace.

GoogleAnalytics -> (строка)

Операция, выполняемая над предоставленными полями источника Google Analytics.

InforNexus -> (строка)

Операция, выполняемая над предоставленными полями источника Infor Nexus.

Marketo -> (строка)

Операция, выполняемая над предоставленными полями источника Marketo.

S3 -> (строка)

Операция, выполняемая над предоставленными полями источника Amazon S3.

Salesforce -> (строка)

Операция, выполняемая над предоставленными полями источника Salesforce.

ServiceNow -> (строка)

Операция, выполняемая над предоставленными полями источника ServiceNow.

Singular -> (строка)

Операция, выполняемая над предоставленными полями источника Singular.

Slack -> (строка)

Операция, выполняемая над предоставленными полями источника Slack.

Trendmicro -> (строка)

Операция, выполняемая над предоставленными полями источника Trend Micro.

Veeva -> (строка)

Операция, выполняемая над предоставленными полями источника Veeva.

Zendesk -> (строка)

Операция, выполняемая над предоставленными полями источника Zendesk.

SAPOData -> (строка)

Операция, выполняемая над предоставленными полями источника SAPOData.

CustomConnector -> (строка)

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

Pardot -> (строка)

Операция, выполняемая над предоставленными полями источника Salesforce Pardot.

destinationField -> (строка)

Поле в коннекторе назначения или значение поля, по которому Amazon AppFlow проверяет поле источника.

taskType -> (строка)

Указывает конкретную реализацию задачи, которую выполняет Amazon AppFlow.

taskProperties -> (массив)

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

key -> (строка)

value -> (строка)

createdAt -> (временная метка)

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

lastUpdatedAt -> (временная метка)

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

createdBy -> (строка)

ARN пользователя, который создал поток.

lastUpdatedBy -> (строка)

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

tags -> (массив)

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

key -> (строка)

value -> (строка)

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

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

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

Указывает конфигурацию, которую Amazon AppFlow использует при каталогизации ваших данных с помощью Glue Data Catalog.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которая предоставляет Amazon AppFlow разрешения, необходимые для создания таблиц, баз данных и разделов каталога данных.

Пример политики IAM с необходимыми разрешениями см. в разделе Примеры политик на основе идентификатора для Amazon AppFlow.

databaseName -> (строка)

Имя базы данных каталога данных, которая хранит таблицы метаданных, создаваемые Amazon AppFlow в вашей учетной записи Amazon Web Services. Эти таблицы содержат метаданные о передаваемых данными потоком, который вы настраиваете с помощью этого параметра.

Примечание

При настройке нового потока с этим параметром необходимо указать существующую базу данных.

tablePrefix -> (строка)

Префикс имени для каждой таблицы каталога данных, которую Amazon AppFlow создает для потока, который вы настраиваете с помощью этого параметра. Amazon AppFlow добавляет префикс к началу каждого имени таблицы.

lastRunMetadataCatalogDetails -> (список)

Описание каталога метаданных, таблицы метаданных и разделов данных, которые Amazon AppFlow использовал для связанного запуска потока.

(структура)

catalogType -> (строка)

Тип каталога метаданных, который Amazon AppFlow использовал для связанного запуска потока. Этот параметр возвращает следующее значение:

GLUE

Каталог метаданных предоставляется Glue Data Catalog. Glue включает Glue Data Catalog в качестве компонента.

tableName -> (строка)

Имя таблицы, которая хранит метаданные для связанного запуска потока. Таблица хранит метаданные, представляющие передаваемые потоком данные. Amazon AppFlow хранит таблицу в каталоге метаданных.

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

Описание статуса попытки Amazon AppFlow зарегистрировать таблицу метаданных в каталоге метаданных. Amazon AppFlow создает или обновляет эту таблицу для связанного запуска потока.

message -> (строка)

Объясняет статус попытки регистрации от Amazon AppFlow. Если попытка завершилась неудачно, сообщение объясняет причину.

result -> (строка)

Указывает количество ресурсов, созданных или обновленных Amazon AppFlow. Возможные ресурсы включают таблицы метаданных и разделы данных.

status -> (строка)

Указывает статус попытки регистрации от Amazon AppFlow.

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

Описание статуса попытки Amazon AppFlow зарегистрировать разделы данных в каталоге метаданных. Разделы данных организуют выходные данные потока в иерархический путь, например, путь к папке в ведре S3. Amazon AppFlow создает разделы (если они еще не существуют) на основе вашей конфигурации потока.

message -> (строка)

result -> (строка)

status -> (строка)

Указывает статус попытки регистрации от Amazon AppFlow.

schemaVersion -> (целое число)

Номер версии вашей схемы данных. Amazon AppFlow присваивает этот номер версии. Номер версии увеличивается на единицу, когда вы изменяете какие-либо из следующих настроек в конфигурации потока:

Сопоставления полей источник-назначение
Типы данных полей
Ключи разделов

END_OF_DOCUMENT_MARKER