создать-поток-интеграции

Описание

Создаёт поток интеграции. Поток интеграции — это асинхронный процесс, который обрабатывает исторические данные и настраивает интеграцию для непрерывных обновлений. Поддерживаемые источники Amazon AppFlow — Salesforce, ServiceNow и Marketo.

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

Синтаксис

  create-integration-workflow
--domain-name <value>
--workflow-type <value>
--integration-config <value>
--object-type-name <value>
--role-arn <value>
[--tags <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]

Параметры

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

Уникальное имя домена.

--workflow-type (строка)

Тип потока. Поддерживается только значение APPFLOW_INTEGRATION.

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

APPFLOW_INTEGRATION

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

Данные конфигурации для потока интеграции.

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

Данные конфигурации для APPFLOW_INTEGRATION типа потока.

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

Настройки, определяющие, как Customer Profiles извлекает данные из источника Amazon AppFlow. Customer Profiles использует эту информацию для создания потока AppFlow от имени клиентов.

Description -> (строка)

Описание создаваемого потока.

FlowName -> (строка)

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

KmsArn -> (строка)

Amazon Resource Name (ARN) ключа AWS Key Management Service (KMS), используемого для шифрования.

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

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

ConnectorProfileName -> (строка)

Имя профиля коннектора AppFlow. Это имя должно быть уникальным для каждого профиля коннектора в аккаунте AWS.

ConnectorType -> (строка)

Тип коннектора, например Salesforce, Marketo и т. д.

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

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

DatetimeTypeFieldName -> (строка)

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

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

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

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

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

Object -> (строка)

Указанный объект в источнике потока Marketo.

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

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

BucketName -> (строка)

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

BucketPrefix -> (строка)

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

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

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

Object -> (строка)

Указанный объект в источнике потока Salesforce.

EnableDynamicFieldUpdate -> (булево)

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

IncludeDeletedRecords -> (булево)

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

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

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

Object -> (строка)

Указанный объект в источнике потока ServiceNow.

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

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

Object -> (строка)

Указанный объект в источнике потока Zendesk.

Tasks -> (список)

Список задач, которые Customer Profiles выполняет при передаче данных в ходе выполнения потока.

(структура)

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

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

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

Marketo -> (строка)

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

S3 -> (строка)

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

Salesforce -> (строка)

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

ServiceNow -> (строка)

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

Zendesk -> (строка)

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

DestinationField -> (строка)

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

SourceFields -> (список)

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

(строка)

TaskProperties -> (массив)

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

key -> (строка)

value -> (строка)

TaskType -> (строка)

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

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

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

TriggerType -> (строка)

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

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

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

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

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

ScheduleExpression -> (строка)

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

DataPullMode -> (строка)

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

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

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

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

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

Timezone -> (строка)

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

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

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

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

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

Batches -> (список)

Пачки в потоке типа APPFLOW_INTEGRATION.

(структура)

Пачка определяет границы извлечения для каждого шага в APPFLOW_INTEGRATION потоке. Поток APPFLOW_INTEGRATION разделяет извлечение на основе этих границ.

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

Начальное время пачки для разделения извлечения.

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

Конечное время пачки для разделения извлечения.

Синтаксис JSON:

{
  "AppflowIntegration": {
    "FlowDefinition": {
      "Description": "string",
      "FlowName": "string",
      "KmsArn": "string",
      "SourceFlowConfig": {
        "ConnectorProfileName": "string",
        "ConnectorType": "Salesforce"|"Marketo"|"Zendesk"|"Servicenow"|"S3",
        "IncrementalPullConfig": {
          "DatetimeTypeFieldName": "string"
        },
        "SourceConnectorProperties": {
          "Marketo": {
            "Object": "string"
          },
          "S3": {
            "BucketName": "string",
            "BucketPrefix": "string"
          },
          "Salesforce": {
            "Object": "string",
            "EnableDynamicFieldUpdate": true|false,
            "IncludeDeletedRecords": true|false
          },
          "ServiceNow": {
            "Object": "string"
          },
          "Zendesk": {
            "Object": "string"
          }
        }
      },
      "Tasks": [
        {
          "ConnectorOperator": {
            "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",
            "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"
          },
          "DestinationField": "string",
          "SourceFields": ["string", ...],
          "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": "string"
            ...},
          "TaskType": "Arithmetic"|"Filter"|"Map"|"Mask"|"Merge"|"Truncate"|"Validate"
        }
        ...
      ],
      "TriggerConfig": {
        "TriggerType": "Scheduled"|"Event"|"OnDemand",
        "TriggerProperties": {
          "Scheduled": {
            "ScheduleExpression": "string",
            "DataPullMode": "Incremental"|"Complete",
            "ScheduleStartTime": timestamp,
            "ScheduleEndTime": timestamp,
            "Timezone": "string",
            "ScheduleOffset": long,
            "FirstExecutionFrom": timestamp
          }
        }
      }
    },
    "Batches": [
      {
        "StartTime": timestamp,
        "EndTime": timestamp
      }
      ...
    ]
  }
}

--object-type-name (строка)

Имя типа объекта профиля.

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

Amazon Resource Name (ARN) роли IAM. Customer Profiles принимает эту роль, чтобы создавать ресурсы от вашего имени в рамках выполнения потока.

--tags (массив)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения из JSON. Невозможно передавать произвольные двоичные данные с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример JSON-ввода, который можно использовать как аргумент для --cli-input-json. Аналогично, при предоставлении yaml-input он выведет образец YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернёт пример JSON-выхода для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку логов.

--endpoint-url (string)

Переопределить URL команды на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

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

--output (string)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурируемого cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

WorkflowId -> (string)

Уникальный идентификатор рабочего процесса.

Message -> (string)

Сообщение, указывающее, что запрос на создание получен.