обновить-поток
Описание
Обновляет существующий поток.
См. также: Документацию API AWS
Синтаксис
update-flow
--flow-name <value>
[--description <value>]
--trigger-config <value>
--source-flow-config <value>
--destination-flow-config-list <value>
--tasks <value>
[--metadata-catalog-config <value>]
[--client-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]
Параметры
--flow-name (строка)
--description (строка)
--trigger-config (структура)
Настройки триггера, определяющие, как и когда запускается поток.
triggerType -> (строка)
OnDemand , Scheduled или Event .triggerProperties -> (структура)
Указывает конфигурационные детали потока, запускаемого по расписанию, как определено пользователем. В настоящее время эти настройки применяются только к типу триггера Scheduled .
Scheduled -> (структура)
Указывает конфигурационные детали потока, запускаемого по расписанию, как определено пользователем.
scheduleExpression -> (строка)
rate(5minutes) .dataPullMode -> (строка)
scheduleStartTime -> (временная метка)
2022-04-26T13:00:00-07:00 .scheduleEndTime -> (временная метка)
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 -> (целое число)
Сокращенный синтаксис:
triggerType=string,triggerProperties={Scheduled={scheduleExpression=string,dataPullMode=string,scheduleStartTime=timestamp,scheduleEndTime=timestamp,timezone=string,scheduleOffset=long,firstExecutionFrom=timestamp,flowErrorDeactivationThreshold=integer}}
Синтаксис JSON:
{
"triggerType": "Scheduled"|"Event"|"OnDemand",
"triggerProperties": {
"Scheduled": {
"scheduleExpression": "string",
"dataPullMode": "Incremental"|"Complete",
"scheduleStartTime": timestamp,
"scheduleEndTime": timestamp,
"timezone": "string",
"scheduleOffset": long,
"firstExecutionFrom": timestamp,
"flowErrorDeactivationThreshold": integer
}
}
}
--source-flow-config (структура)
Содержит информацию о конфигурации подключенного источника, используемого в потоке.
connectorType -> (строка)
apiVersion -> (строка)
connectorProfileName -> (строка)
sourceConnectorProperties -> (структура)
Указывает информацию, необходимую для запроса к конкретному подключенному источнику.
Amplitude -> (структура)
Указывает информацию, необходимую для запроса к Amplitude.
object -> (строка)
Datadog -> (структура)
Указывает информацию, необходимую для запроса к Datadog.
object -> (строка)
Dynatrace -> (структура)
Указывает информацию, необходимую для запроса к Dynatrace.
object -> (строка)
GoogleAnalytics -> (структура)
Указывает информацию, необходимую для запроса к Google Analytics.
object -> (строка)
InforNexus -> (структура)
Указывает информацию, необходимую для запроса к Infor Nexus.
object -> (строка)
Marketo -> (структура)
Указывает информацию, необходимую для запроса к Marketo.
object -> (строка)
S3 -> (структура)
Указывает информацию, необходимую для запроса к Amazon S3.
bucketName -> (строка)
bucketPrefix -> (строка)
s3InputFormatConfig -> (структура)
При использовании Amazon S3 в качестве источника, формат конфигурации, который вы предоставляете для входных данных потока.
s3InputFileType -> (строка)
Salesforce -> (структура)
Указывает информацию, необходимую для запроса к Salesforce.
object -> (строка)
enableDynamicFieldUpdate -> (булево)
includeDeletedRecords -> (булево)
dataTransferApi -> (строка)
Указывает, какой API Salesforce используется Amazon AppFlow при передаче данных из Salesforce.
По умолчанию. Amazon AppFlow выбирает API для использования, основываясь на количестве записей, передаваемых потоком из Salesforce. Если поток передает менее 1 000 000 записей, Amazon AppFlow использует REST API Salesforce. Если поток передает 1 000 000 записей или более, Amazon AppFlow использует Bulk API 2.0 Salesforce.
Каждый из этих API Salesforce структурирует данные по-разному. Если Amazon AppFlow выбирает API автоматически, имейте в виду, что для повторяющихся потоков выходные данные могут отличаться от одного выполнения потока к другому. Например, если поток выполняется ежедневно, он может использовать REST API в один день для передачи 900 000 записей, а на следующий день — Bulk API 2.0 для передачи 1 100 000 записей. В каждом из этих выполнений потока соответствующий API Salesforce форматирует данные по-разному. Некоторые различия включают, как форматируются даты и как представлены нулевые значения. Также Bulk API 2.0 не передает составные поля Salesforce.
Выбрав этот параметр, вы оптимизируете производительность потока как для небольших, так и для больших передаваемых объемов данных, но компромисс заключается в несогласованном формате вывода.
Amazon AppFlow использует только Bulk API 2.0 Salesforce. Этот API выполняет асинхронную передачу данных и является оптимальным для больших наборов данных. Выбрав этот параметр, вы обеспечиваете согласованный вывод вашего потока, но оптимизируете производительность только для больших передаваемых объемов данных.
Обратите внимание, что Bulk API 2.0 не передает составные поля Salesforce.
Amazon AppFlow использует только REST API Salesforce. Выбрав этот параметр, вы обеспечиваете согласованный вывод вашего потока, но снижаете производительность для больших передаваемых объемов данных, которые лучше подходят для Bulk API 2.0. В некоторых случаях, если поток пытается передать очень большой объем данных, он может завершиться ошибкой с временным ограничением.
ServiceNow -> (структура)
Указывает информацию, необходимую для запроса к ServiceNow.
object -> (строка)
Singular -> (структура)
Указывает информацию, необходимую для запроса к Singular.
object -> (строка)
Slack -> (структура)
Указывает информацию, необходимую для запроса к Slack.
object -> (строка)
Trendmicro -> (структура)
Указывает информацию, необходимую для запроса к Trend Micro.
object -> (строка)
Veeva -> (структура)
Указывает информацию, необходимую для запроса к Veeva.
object -> (строка)
documentType -> (строка)
includeSourceFiles -> (булево)
includeRenditions -> (булево)
includeAllVersions -> (булево)
Zendesk -> (структура)
Указывает информацию, необходимую для запроса к Zendesk.
object -> (строка)
SAPOData -> (структура)
Свойства, применяемые при использовании SAPOData в качестве источника потока.
objectPath -> (строка)
parallelismConfig -> (структура)
Устанавливает количество одновременных процессов, передающих записи OData из вашей системы SAP.
maxParallelism -> (целое число)
paginationConfig -> (структура)
Устанавливает размер страницы для каждого одновременного процесса, передающего записи OData из вашей системы SAP.
maxPageSize -> (целое число)
CustomConnector -> (структура)
Свойства, применяемые при использовании пользовательского подключения в качестве источника.
entityName -> (строка)
customProperties -> (карта)
Дополнительные свойства, необходимые для использования пользовательского подключения в качестве источника.
key -> (строка)
value -> (строка)
dataTransferApi -> (структура)
API приложения подключения, которое Amazon AppFlow использует для передачи данных.
Name -> (строка)
Type -> (строка)
Вы можете указать один из следующих типов:
По умолчанию. Оптимизирует поток для наборов данных, размер которых варьируется от небольших до больших. Для каждого выполнения потока Amazon AppFlow выбирает тип API SYNC или ASYNC в зависимости от объема передаваемых данных.
Синхронный API. Этот тип API оптимизирует поток для наборов данных от небольших до средних.
Асинхронный API. Этот тип API оптимизирует поток для больших наборов данных.
Pardot -> (структура)
Указывает информацию, необходимую для запроса к Pardot Salesforce.
object -> (строка)
incrementalPullConfig -> (структура)
Определяет конфигурацию для планируемого инкрементального извлечения данных. Если предоставлена допустимая конфигурация, поля, указанные в конфигурации, используются при запросе инкрементальных данных.
datetimeTypeFieldName -> (строка)
JSON Синтаксис:
{
"connectorType": "Salesforce"|"Singular"|"Slack"|"Redshift"|"S3"|"Marketo"|"Googleanalytics"|"Zendesk"|"Servicenow"|"Datadog"|"Trendmicro"|"Snowflake"|"Dynatrace"|"Infornexus"|"Amplitude"|"Veeva"|"EventBridge"|"LookoutMetrics"|"Upsolver"|"Honeycode"|"CustomerProfiles"|"SAPOData"|"CustomConnector"|"Pardot",
"apiVersion": "string",
"connectorProfileName": "string",
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"
},
"Datadog": {
"object": "string"
},
"Dynatrace": {
"object": "string"
},
"GoogleAnalytics": {
"object": "string"
},
"InforNexus": {
"object": "string"
},
"Marketo": {
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3InputFormatConfig": {
"s3InputFileType": "CSV"|"JSON"
}
},
"Salesforce": {
"object": "string",
"enableDynamicFieldUpdate": true|false,
"includeDeletedRecords": true|false,
"dataTransferApi": "AUTOMATIC"|"BULKV2"|"REST_SYNC"
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"object": "string",
"documentType": "string",
"includeSourceFiles": true|false,
"includeRenditions": true|false,
"includeAllVersions": true|false
},
"Zendesk": {
"object": "string"
},
"SAPOData": {
"objectPath": "string",
"parallelismConfig": {
"maxParallelism": integer
},
"paginationConfig": {
"maxPageSize": integer
}
},
"CustomConnector": {
"entityName": "string",
"customProperties": {"string": "string"
...},
"dataTransferApi": {
"Name": "string",
"Type": "SYNC"|"ASYNC"|"AUTOMATIC"
}
},
"Pardot": {
"object": "string"
}
},
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
}
}
--destination-flow-config-list (список)
Настройка, которая управляет тем, как Amazon AppFlow передает данные в подключение назначения.
(структура)
Содержит информацию о настройке подключений назначения, присутствующих в потоке.
connectorType -> (строка)
apiVersion -> (строка)
connectorProfileName -> (строка)
destinationConnectorProperties -> (структура)
Здесь хранится информация, необходимая для запроса конкретного подключения.
Redshift -> (структура)
Свойства, необходимые для запроса Amazon Redshift.
object -> (строка)
intermediateBucketName -> (строка)
bucketPrefix -> (строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения Amazon Redshift. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей подключения назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
S3 -> (структура)
Свойства, необходимые для запроса Amazon S3.
bucketName -> (строка)
bucketPrefix -> (строка)
s3OutputFormatConfig -> (структура)
Настройка, определяющая, как Amazon AppFlow должен форматировать выходные данные потока при использовании Amazon S3 в качестве пункта назначения.
fileType -> (строка)
prefixConfig -> (структура)
Определяет префикс, который Amazon AppFlow применяет к имени папки в Amazon S3 bucket. Вы можете называть папки в соответствии с частотой и датой потока.
prefixType -> (строка)
prefixFormat -> (строка)
pathPrefixHierarchy -> (список)
Указывает, включает ли путь к целевому файлу следующие элементы:
Идентификатор, который Amazon AppFlow присваивает запуску потока.
Номер версии вашей схемы данных. Amazon AppFlow присваивает этот номер версии. Номер версии увеличивается на единицу при изменении любых из следующих настроек в вашей конфигурации потока:
- Сопоставления полей от источника к пункту назначения
- Типы данных полей
- Ключи разделения
(строка)
aggregationConfig -> (структура)
Настройки агрегации, которые можно использовать для настройки формата выходных данных вашего потока.
aggregationType -> (строка)
targetFileSize -> (целое число)
preserveSourceDataTyping -> (булево)
Если формат выходного файла Parquet, используйте этот параметр, чтобы задать, сохраняет ли Amazon AppFlow типы данных в исходных данных при записи выходных данных в Amazon S3.
-
true: Amazon AppFlow сохраняет типы данных при записи в Amazon S3. Например, целое число или1в исходных данных по-прежнему является целым числом в выходе. -
false: Amazon AppFlow преобразует все исходные данные в строки при записи в Amazon S3. Например, целое число1в исходных данных становится строкой"1"на выходе.
Salesforce -> (структура)
Свойства, необходимые для запроса Salesforce.
object -> (строка)
idFieldNames -> (список)
Имя поля, которое Amazon AppFlow использует в качестве идентификатора при выполнении операции записи, например, обновления или удаления.
(строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения Salesforce. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей подключения назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
writeOperationType -> (строка)
UPSERT, тогда необходимо idFieldNames.dataTransferApi -> (строка)
Указывает, какой API Salesforce используется Amazon AppFlow, когда ваш поток передает данные в Salesforce.
По умолчанию. Amazon AppFlow выбирает используемый API на основе количества записей, передаваемых вашим потоком в Salesforce. Если ваш поток передает менее 1000 записей, Amazon AppFlow использует API REST Salesforce. Если ваш поток передает 1000 записей или более, Amazon AppFlow использует API Bulk API 2.0 Salesforce.
Каждый из этих API Salesforce структурирует данные по-разному. Если Amazon AppFlow выбирает API автоматически, имейте в виду, что для повторяющихся потоков выходные данные могут отличаться от одного запуска потока к другому. Например, если поток запускается ежедневно, он может использовать REST API в один день для передачи 900 записей и использовать API Bulk 2.0 на следующий день для передачи 1100 записей. Для каждого из этих запусков потока соответствующий API Salesforce форматирует данные по-разному. Некоторые из отличий включают то, как форматируются даты и представляются нулевые значения. Также API Bulk 2.0 не передает составные поля Salesforce.
Выбрав этот вариант, вы оптимизируете производительность потока как для небольших, так и для больших объемов передачи данных, но компромисс заключается в несогласованном форматировании на выходе.
Amazon AppFlow использует только API Bulk API 2.0 Salesforce. Этот API выполняет асинхронные передачи данных и идеально подходит для больших наборов данных. Выбрав этот вариант, вы обеспечиваете согласованный вывод вашего потока, но оптимизируете производительность только для больших объемов передачи данных.
Обратите внимание, что API Bulk API 2.0 не передает составные поля Salesforce.
Amazon AppFlow использует только API REST Salesforce. Выбрав этот вариант, вы обеспечиваете согласованный вывод вашего потока, но снижаете производительность при передаче больших объемов данных, которые лучше подходят для API Bulk API 2.0. В некоторых случаях, если ваш поток пытается передать очень большой объем данных, он может завершиться с ошибкой таймаута.
Snowflake -> (структура)
Свойства, необходимые для запроса Snowflake.
object -> (строка)
intermediateBucketName -> (строка)
bucketPrefix -> (строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения Snowflake. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей подключения назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
EventBridge -> (структура)
Свойства, необходимые для запроса Amazon EventBridge.
object -> (строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig является частью деталей подключения назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
LookoutMetrics -> (структура)
Upsolver -> (структура)
Свойства, необходимые для запроса Upsolver.
bucketName -> (строка)
bucketPrefix -> (строка)
s3OutputFormatConfig -> (структура)
Настройка, определяющая формат данных при использовании Upsolver в качестве целевого компонента потока.
fileType -> (строка)
prefixConfig -> (структура)
Определяет элементы, которые Amazon AppFlow включает в имена файлов и папок в целевом компоненте потока.
prefixType -> (строка)
prefixFormat -> (строка)
pathPrefixHierarchy -> (список)
Определяет, включает ли путь к целевому файлу следующие элементы или оба:
Идентификатор, назначенный Amazon AppFlow для выполнения потока.
Номер версии вашей схемы данных. Amazon AppFlow назначает этот номер версии. Номер версии увеличивается на единицу, когда вы изменяете какие-либо из следующих параметров в настройках потока:
- Сопоставления полей «Источник — Цель»
- Типы данных полей
- Ключи разбиения
(строка)
aggregationConfig -> (структура)
Настройки агрегации, которые можно использовать для настройки формата выходных данных вашего потока.
aggregationType -> (строка)
targetFileSize -> (целое число)
Honeycode -> (структура)
Свойства, необходимые для запроса Amazon Honeycode.
object -> (строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в целевом компоненте. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig — часть деталей коннектора назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
CustomerProfiles -> (структура)
Свойства, необходимые для запроса Amazon Connect Customer Profiles.
domainName -> (строка)
objectTypeName -> (строка)
Zendesk -> (структура)
Свойства, необходимые для запроса Zendesk.
object -> (строка)
idFieldNames -> (список)
Список имен полей, которые можно использовать в качестве поля ID при выполнении операции записи.
(строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в целевом компоненте. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig — часть деталей коннектора назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
writeOperationType -> (строка)
INSERT.Marketo -> (структура)
Свойства, необходимые для запроса Marketo.
object -> (строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в целевом компоненте. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig — часть деталей коннектора назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
CustomConnector -> (структура)
Свойства, необходимые для запроса пользовательского коннектора.
entityName -> (строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пользовательском коннекторе в качестве назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
writeOperationType -> (строка)
idFieldNames -> (список)
Имя поля, которое Amazon AppFlow использует в качестве ID при выполнении операции записи, такой как обновление, удаление или обновление.
(строка)
customProperties -> (карта)
Пользовательские свойства, специфичные для коннектора, когда он используется в качестве назначения в потоке.
key -> (строка)
value -> (строка)
SAPOData -> (структура)
Свойства, необходимые для запроса SAPOData.
objectPath -> (строка)
successResponseHandlingConfig -> (структура)
Определяет, как Amazon AppFlow обрабатывает успешный ответ, полученный от коннектора после размещения данных.
Например, эта настройка определяет, где записывать ответ от коннектора назначения при успешной операции вставки.
bucketPrefix -> (строка)
bucketName -> (строка)
idFieldNames -> (список)
Список имен полей, которые можно использовать в качестве поля ID при выполнении операции записи.
(строка)
errorHandlingConfig -> (структура)
Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в целевом компоненте. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. ErrorHandlingConfig — часть деталей коннектора назначения.
failOnFirstDestinationError -> (булево)
bucketPrefix -> (строка)
bucketName -> (строка)
writeOperationType -> (строка)
INSERT.Синтаксис JSON:
[
{
"connectorType": "Salesforce"|"Singular"|"Slack"|"Redshift"|"S3"|"Marketo"|"Googleanalytics"|"Zendesk"|"Servicenow"|"Datadog"|"Trendmicro"|"Snowflake"|"Dynatrace"|"Infornexus"|"Amplitude"|"Veeva"|"EventBridge"|"LookoutMetrics"|"Upsolver"|"Honeycode"|"CustomerProfiles"|"SAPOData"|"CustomConnector"|"Pardot",
"apiVersion": "string",
"connectorProfileName": "string",
"destinationConnectorProperties": {
"Redshift": {
"object": "string",
"intermediateBucketName": "string",
"bucketPrefix": "string",
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
}
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"fileType": "CSV"|"JSON"|"PARQUET",
"prefixConfig": {
"prefixType": "FILENAME"|"PATH"|"PATH_AND_FILENAME",
"prefixFormat": "YEAR"|"MONTH"|"DAY"|"HOUR"|"MINUTE",
"pathPrefixHierarchy": ["EXECUTION_ID"|"SCHEMA_VERSION", ...]
},
"aggregationConfig": {
"aggregationType": "None"|"SingleFile",
"targetFileSize": long
},
"preserveSourceDataTyping": true|false
}
},
"Salesforce": {
"object": "string",
"idFieldNames": ["string", ...],
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
},
"writeOperationType": "INSERT"|"UPSERT"|"UPDATE"|"DELETE",
"dataTransferApi": "AUTOMATIC"|"BULKV2"|"REST_SYNC"
},
"Snowflake": {
"object": "string",
"intermediateBucketName": "string",
"bucketPrefix": "string",
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
}
},
"EventBridge": {
"object": "string",
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
}
},
"LookoutMetrics": {
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"fileType": "CSV"|"JSON"|"PARQUET",
"prefixConfig": {
"prefixType": "FILENAME"|"PATH"|"PATH_AND_FILENAME",
"prefixFormat": "YEAR"|"MONTH"|"DAY"|"HOUR"|"MINUTE",
"pathPrefixHierarchy": ["EXECUTION_ID"|"SCHEMA_VERSION", ...]
},
"aggregationConfig": {
"aggregationType": "None"|"SingleFile",
"targetFileSize": long
}
}
},
"Honeycode": {
"object": "string",
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
}
},
"CustomerProfiles": {
"domainName": "string",
"objectTypeName": "string"
},
"Zendesk": {
"object": "string",
"idFieldNames": ["string", ...],
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
},
"writeOperationType": "INSERT"|"UPSERT"|"UPDATE"|"DELETE"
},
"Marketo": {
"object": "string",
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
}
},
"CustomConnector": {
"entityName": "string",
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
},
"writeOperationType": "INSERT"|"UPSERT"|"UPDATE"|"DELETE",
"idFieldNames": ["string", ...],
"customProperties": {"string": "string"
...}
},
"SAPOData": {
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketPrefix": "string",
"bucketName": "string"
},
"idFieldNames": ["string", ...],
"errorHandlingConfig": {
"failOnFirstDestinationError": true|false,
"bucketPrefix": "string",
"bucketName": "string"
},
"writeOperationType": "INSERT"|"UPSERT"|"UPDATE"|"DELETE"
}
}
}
...
]
--tasks (список)
Список задач, которые выполняет Amazon AppFlow при передаче данных в ходе выполнения потока.
(структура)
Класс для моделирования различных типов задач. Реализация задачи варьируется в зависимости от TaskType.
sourceFields -> (список)
Поля источника, к которым применяется конкретная задача.
(строка)
connectorOperator -> (структура)
Операция, которая должна быть выполнена над предоставленными полями источника.
Amplitude -> (строка)
Datadog -> (строка)
Dynatrace -> (строка)
GoogleAnalytics -> (строка)
InforNexus -> (строка)
Marketo -> (строка)
S3 -> (строка)
Salesforce -> (строка)
ServiceNow -> (строка)
Singular -> (строка)
Slack -> (строка)
Trendmicro -> (строка)
Veeva -> (строка)
Zendesk -> (строка)
SAPOData -> (строка)
CustomConnector -> (строка)
Pardot -> (строка)
destinationField -> (строка)
taskType -> (строка)
taskProperties -> (массив)
Массив, используемый для хранения информации, связанной с задачей. Служба выполнения ищет определенную информацию, основанную на TaskType.
key -> (строка)
value -> (строка)
Краткая синтаксическая запись:
sourceFields=string,string,connectorOperator={Amplitude=string,Datadog=string,Dynatrace=string,GoogleAnalytics=string,InforNexus=string,Marketo=string,S3=string,Salesforce=string,ServiceNow=string,Singular=string,Slack=string,Trendmicro=string,Veeva=string,Zendesk=string,SAPOData=string,CustomConnector=string,Pardot=string},destinationField=string,taskType=string,taskProperties={KeyName1=string,KeyName2=string} ...
Синтаксис JSON:
[
{
"sourceFields": ["string", ...],
"connectorOperator": {
"Amplitude": "BETWEEN",
"Datadog": "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Dynatrace": "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"GoogleAnalytics": "PROJECTION"|"BETWEEN",
"InforNexus": "PROJECTION"|"BETWEEN"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Marketo": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"S3": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Salesforce": "PROJECTION"|"LESS_THAN"|"CONTAINS"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"ServiceNow": "PROJECTION"|"CONTAINS"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Singular": "PROJECTION"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Slack": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Trendmicro": "PROJECTION"|"EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Veeva": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"CONTAINS"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Zendesk": "PROJECTION"|"GREATER_THAN"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"SAPOData": "PROJECTION"|"LESS_THAN"|"CONTAINS"|"GREATER_THAN"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"CustomConnector": "PROJECTION"|"LESS_THAN"|"GREATER_THAN"|"CONTAINS"|"BETWEEN"|"LESS_THAN_OR_EQUAL_TO"|"GREATER_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"NOT_EQUAL_TO"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"|"NO_OP",
"Pardot": "PROJECTION"|"EQUAL_TO"|"NO_OP"|"ADDITION"|"MULTIPLICATION"|"DIVISION"|"SUBTRACTION"|"MASK_ALL"|"MASK_FIRST_N"|"MASK_LAST_N"|"VALIDATE_NON_NULL"|"VALIDATE_NON_ZERO"|"VALIDATE_NON_NEGATIVE"|"VALIDATE_NUMERIC"
},
"destinationField": "string",
"taskType": "Arithmetic"|"Filter"|"Map"|"Map_all"|"Mask"|"Merge"|"Passthrough"|"Truncate"|"Validate"|"Partition",
"taskProperties": {"VALUE"|"VALUES"|"DATA_TYPE"|"UPPER_BOUND"|"LOWER_BOUND"|"SOURCE_DATA_TYPE"|"DESTINATION_DATA_TYPE"|"VALIDATION_ACTION"|"MASK_VALUE"|"MASK_LENGTH"|"TRUNCATE_LENGTH"|"MATH_OPERATION_FIELDS_ORDER"|"CONCAT_FORMAT"|"SUBFIELD_CATEGORY_MAP"|"EXCLUDE_SOURCE_FIELDS_LIST"|"INCLUDE_NEW_FIELDS"|"ORDERED_PARTITION_KEYS_LIST": "string"
...}
}
...
]
--metadata-catalog-config (структура)
Определяет конфигурацию, которую Amazon AppFlow использует при каталогизации данных, передаваемых связанным потоком. Когда Amazon AppFlow каталогизирует данные из потока, он сохраняет метаданные в каталоге данных.
glueDataCatalog -> (структура)
Определяет конфигурацию, которую Amazon AppFlow использует при каталогизации данных с помощью каталога данных Glue.
roleArn -> (строка)
Идентификатор ресурса Amazon (ARN) роли IAM, предоставляющей Amazon AppFlow необходимые разрешения для создания таблиц, баз данных и разделов каталога данных.
Пример политики IAM с необходимыми разрешениями см. в разделе Примеры политик, основанных на идентификаторе, для Amazon AppFlow.
databaseName -> (строка)
Имя базы данных каталога данных, в которой хранятся таблицы метаданных, созданные Amazon AppFlow в вашей учетной записи Amazon Web Services. Эти таблицы содержат метаданные о данных, передаваемых потоком, который вы настраиваете с помощью этого параметра.
Примечание
При настройке нового потока с этим параметром необходимо указать существующую базу данных.tablePrefix -> (строка)
Краткая синтаксическая запись:
glueDataCatalog={roleArn=string,databaseName=string,tablePrefix=string}
Синтаксис JSON:
{
"glueDataCatalog": {
"roleArn": "string",
"databaseName": "string",
"tablePrefix": "string"
}
}
--client-token (строка)
Параметр clientToken — это маркер идемпотентности. Он гарантирует, что ваш запрос UpdateFlow выполняется только один раз. Вы выбираете значение для передачи. Например, если вы не получили ответ от запроса, вы можете безопасно повторить запрос со значением параметра clientToken.
Если вы опустите значение clientToken, используемый вами SDK Amazon Web Services вставит значение за вас. Таким образом, SDK может безопасно повторять запросы несколько раз после ошибки сети. Вы должны предоставить собственное значение для других случаев использования.
Если вы укажете входные параметры, отличающиеся от первого запроса, произойдет ошибка. Если вы используете другое значение для clientToken, Amazon AppFlow рассматривает это как новый вызов к UpdateFlow. Токен активен в течение 8 часов.
--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 (логическое значение)
Автоматически запрашивать входные параметры командной строки.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запрошение входных параметров командной строки.
Вывод
flowStatus -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.