создать-поток

Описание

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

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

Синтаксис

  create-flow
--flow-name <value>
[--description <value>]
[--kms-arn <value>]
--trigger-config <value>
--source-flow-config <value>
--destination-flow-config-list <value>
--tasks <value>
[--tags <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 (строка)

Описание потока, который вы хотите создать.

--kms-arn (строка)

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

--trigger-config (структура)

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

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 деактивирует его.

Сокращенный синтаксис:

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 (структура)

Настройка, которая определяет, как 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 -> (структура)

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

object -> (строка)

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

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

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

apiVersion -> (строка)

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

connectorProfileName -> (строка)

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 использует Salesforce REST API. Если поток передает 1000 записей или более, Amazon AppFlow использует Salesforce Bulk API 2.0.

Каждый из этих 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 использует только Salesforce REST API. Выбрав этот вариант, вы гарантируете согласованный вывод потока, но уменьшите производительность при передаче больших объемов данных, более подходящих для 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 -> (строка)

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

bucketPrefix -> (строка)

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

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

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

fileType -> (строка)

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

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

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

prefixType -> (строка)

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

prefixFormat -> (строка)

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

pathPrefixHierarchy -> (список)

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

EXECUTION_ID

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

SCHEMA_VERSION

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

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

(строка)

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

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

aggregationType -> (строка)

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

targetFileSize -> (целое)

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 -> (структура)

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

failOnFirstDestinationError -> (булево)

bucketPrefix -> (строка)

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

bucketName -> (строка)

Указывает имя ведра Amazon S3.

writeOperationType -> (строка)

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

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

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

object -> (строка)

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

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

Настройки, определяющие, как Amazon AppFlow обрабатывает ошибку при размещении данных в пункте назначения. Например, эта настройка определяет, должен ли поток завершиться после одной ошибки вставки или продолжить и попытаться вставить каждую запись независимо от первоначальной ошибки. 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 -> (структура)

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

failOnFirstDestinationError -> (булево)

bucketPrefix -> (строка)

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

bucketName -> (строка)

Указывает имя ведра Amazon S3.

writeOperationType -> (строка)

Синтаксис 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 -> (строка)

Операция, которая должна быть выполнена над предоставленными полями источника 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 -> (строка)

Сокращенная синтаксическая запись:

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"
      ...}
  }
  ...
]

--tags (карта)

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

key -> (строка)

value -> (строка)

Сокращенная синтаксическая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--metadata-catalog-config (структура)

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

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

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

roleArn -> (строка)

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

Пример политики IAM с необходимыми разрешениями см. в Identity-based policy examples for Amazon AppFlow.

databaseName -> (строка)

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

Примечание

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

tablePrefix -> (строка)

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

Сокращенная синтаксическая запись:

glueDataCatalog={roleArn=string,databaseName=string,tablePrefix=string}

Синтаксис JSON:

{
  "glueDataCatalog": {
    "roleArn": "string",
    "databaseName": "string",
    "tablePrefix": "string"
  }
}

--client-token (строка)

Параметр clientToken — это маркер идемпотентности. Он гарантирует, что ваш запрос CreateFlow завершится только один раз. Вы выбираете значение для передачи. Например, если вы не получаете ответа от вашего запроса, вы можете безопасно повторить запрос со значением того же параметра clientToken.

Если вы опустите значение clientToken, используемый Amazon Web Services SDK вставит значение за вас. Таким образом, SDK может безопасно повторно отправлять запросы несколько раз после сетевой ошибки. Вы должны предоставить собственное значение для других случаев использования.

Если вы укажете входные параметры, отличающиеся от первого запроса, произойдет ошибка. Если вы используете другое значение для clientToken, Amazon AppFlow рассматривает это как новый вызов для CreateFlow. Токен активен в течение 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 для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать входные параметры CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы входных параметров CLI.

Вывод

flowArn -> (строка)

Amazon Resource Name (ARN) потока.

flowStatus -> (строка)

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