put-integration

Описание

Добавляет интеграцию между сервисом и сторонним сервисом, включая Amazon AppFlow и Amazon Connect.

Интеграция может принадлежать только одному домену.

Чтобы добавить или удалить теги для существующей интеграции, см. TagResource /UntagResource.

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

Синтаксис

  put-integration
--domain-name <value>
[--uri <value>]
[--object-type-name <value>]
[--tags <value>]
[--flow-definition <value>]
[--object-type-names <value>]
[--role-arn <value>]
[--event-trigger-names <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 (строка)

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

--uri (строка)

URI хранилища S3 или любого другого типа источника данных.

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

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

--tags (карта)

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

ключ -> (строка)

значение -> (строка)

Сокращенная форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--flow-definition (структура)

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

Описание -> (строка)

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

FlowName -> (строка)

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

KmsArn -> (строка)

Amazon Resource Name (ARN) ключа управления ключами AWS (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.

ключ -> (строка)

значение -> (строка)

TaskType -> (строка)

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

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

Настройки триггера, определяющие, как и когда запускается поток.

TriggerType -> (строка)

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

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

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

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

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

ScheduleExpression -> (строка)

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

DataPullMode -> (строка)

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

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

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

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

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

Timezone -> (строка)

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

ScheduleOffset -> (целое)

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

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

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

Синтаксис JSON:

{
  "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
      }
    }
  }
}

--object-type-names (карта)

Карта, в которой каждый ключ — это тип события из внешнего приложения, такого как Segment или Shopify, а каждое значение — ObjectTypeName (шаблон), используемый для приема события. Поддерживает следующие типы событий: SegmentIdentify , ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , ShopifyUpdateDraftOrders , ShopifyCreateOrders и ShopifyUpdatedOrders.

ключ -> (строка)

значение -> (строка)

Сокращенная форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

--event-trigger-names (список)

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

(строка)

Синтаксис:

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

Вывод

DomainName -> (string)

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

Uri -> (string)

URI S3-бакета или любого другого типа источника данных.

ObjectTypeName -> (string)

Название типа объекта профиля.

CreatedAt -> (timestamp)

Отметка времени создания домена.

LastUpdatedAt -> (timestamp)

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

Tags -> (map)

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

key -> (string)

value -> (string)

ObjectTypeNames -> (map)

Словарь, в котором каждый ключ — это тип события из внешнего приложения, такого как Segment или Shopify, а каждое значение — это ObjectTypeName (шаблон), используемый для обработки события. Поддерживает следующие типы событий: SegmentIdentify , ShopifyCreateCustomers , ShopifyUpdateCustomers , ShopifyCreateDraftOrders , ShopifyUpdateDraftOrders , ShopifyCreateOrders и ShopifyUpdatedOrders .

key -> (string)

value -> (string)

WorkflowId -> (string)

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

IsUnstructured -> (boolean)

Булево значение, показывающее, создан ли поток, связанный с интеграцией, в Amazon Appflow или с ObjectTypeName, равным _unstructured через API/CLI в flowDefinition.

RoleArn -> (string)

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

EventTriggerNames -> (list)

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

(string)