Class: Aws::CustomerProfiles::Types::GetIntegrationResponse

Inherits:

Struct

• Object
• Struct
• Aws::CustomerProfiles::Types::GetIntegrationResponse

Defined in:

gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The timestamp of when the domain was created.

• #domain_name ⇒ String

  The unique name of the domain.

• #event_trigger_names ⇒ Array<String>

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

• #is_unstructured ⇒ Boolean

  Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

• #last_updated_at ⇒ Time

  The timestamp of when the domain was most recently edited.

• #object_type_name ⇒ String

  The name of the profile object type.

• #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.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role.

• #scope ⇒ String

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

• #tags ⇒ Hash<String,String>

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

• #uri ⇒ String

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

• #workflow_id ⇒ String

  Unique identifier for the workflow.

Instance Attribute Details

#created_at ⇒ Time

The timestamp of when the domain was created.

Returns:

• (Time)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#event_trigger_names ⇒ Array<String>

A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#is_unstructured ⇒ Boolean

Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals _unstructured via API/CLI in flowDefinition.

Returns:

• (Boolean)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The timestamp of when the domain was most recently edited.

Returns:

• (Time)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#object_type_name ⇒ String

The name of the profile object type.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  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>)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#uri ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

Unique identifier for the workflow.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 4134

class GetIntegrationResponse < Struct.new(
  :domain_name,
  :uri,
  :object_type_name,
  :created_at,
  :last_updated_at,
  :tags,
  :object_type_names,
  :workflow_id,
  :is_unstructured,
  :role_arn,
  :event_trigger_names,
  :scope)
  SENSITIVE = []
  include Aws::Structure
end