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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:flow_definition]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#event_trigger_names ⇒ Array<String>

A list of unique names for active event triggers associated with the integration.

Returns:

  • (Array<String>) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#flow_definition ⇒ Types::FlowDefinition

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

Returns:



8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#object_type_name ⇒ String

The name of the profile object type.

Returns:

  • (String) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#object_type_names ⇒ Hash<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>) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.

Returns:

  • (String) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#scope ⇒ String

Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.

Returns:

  • (String) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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

#uri ⇒ String

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

Returns:

  • (String) 


8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
 
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 8358

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