Class: Aws::CustomerProfiles::Types::PutIntegrationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Note:

When making an API call, you may pass PutIntegrationRequest data as a hash:

{
  domain_name: "name", # required
  uri: "string1To255",
  object_type_name: "typeName",
  tags: {
    "TagKey" => "TagValue",
  },
  flow_definition: {
    description: "FlowDescription",
    flow_name: "FlowName", # required
    kms_arn: "KmsArn", # required
    source_flow_config: { # required
      connector_profile_name: "ConnectorProfileName",
      connector_type: "Salesforce", # required, accepts Salesforce, Marketo, Zendesk, Servicenow, S3
      incremental_pull_config: {
        datetime_type_field_name: "DatetimeTypeFieldName",
      },
      source_connector_properties: { # required
        marketo: {
          object: "Object", # required
        },
        s3: {
          bucket_name: "BucketName", # required
          bucket_prefix: "BucketPrefix",
        },
        salesforce: {
          object: "Object", # required
          enable_dynamic_field_update: false,
          include_deleted_records: false,
        },
        service_now: {
          object: "Object", # required
        },
        zendesk: {
          object: "Object", # required
        },
      },
    },
    tasks: [ # required
      {
        connector_operator: {
          marketo: "PROJECTION", # accepts 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", # accepts 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", # accepts 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
          service_now: "PROJECTION", # accepts 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", # accepts 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
        },
        destination_field: "DestinationField",
        source_fields: ["stringTo2048"], # required
        task_properties: {
          "VALUE" => "Property",
        },
        task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Mask, Merge, Truncate, Validate
      },
    ],
    trigger_config: { # required
      trigger_type: "Scheduled", # required, accepts Scheduled, Event, OnDemand
      trigger_properties: {
        scheduled: {
          schedule_expression: "ScheduleExpression", # required
          data_pull_mode: "Incremental", # accepts Incremental, Complete
          schedule_start_time: Time.now,
          schedule_end_time: Time.now,
          timezone: "Timezone",
          schedule_offset: 1,
          first_execution_from: Time.now,
        },
      },
    },
  },
  object_type_names: {
    "string1To255" => "typeName",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

The unique name of the domain.

Returns:

  • (String)


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3896

class PutIntegrationRequest < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :tags,
  :flow_definition,
  :object_type_names)
  SENSITIVE = []
  include Aws::Structure
end

#flow_definitionTypes::FlowDefinition

The configuration that controls how Customer Profiles retrieves data from the source.



3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3896

class PutIntegrationRequest < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :tags,
  :flow_definition,
  :object_type_names)
  SENSITIVE = []
  include Aws::Structure
end

#object_type_nameString

The name of the profile object type.

Returns:

  • (String)


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3896

class PutIntegrationRequest < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :tags,
  :flow_definition,
  :object_type_names)
  SENSITIVE = []
  include Aws::Structure
end

#object_type_namesHash<String,String>

A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event. It supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, ShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.

Returns:

  • (Hash<String,String>)


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3896

class PutIntegrationRequest < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :tags,
  :flow_definition,
  :object_type_names)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>)


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3896

class PutIntegrationRequest < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :tags,
  :flow_definition,
  :object_type_names)
  SENSITIVE = []
  include Aws::Structure
end

#uriString

The URI of the S3 bucket or any other type of data source.

Returns:

  • (String)


3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3896

class PutIntegrationRequest < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :tags,
  :flow_definition,
  :object_type_names)
  SENSITIVE = []
  include Aws::Structure
end