Skip to content

PutIntegrationRequest

Source code in docs_src/capo_customer_profiles/types/put_integration_request.py
class PutIntegrationRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    uri: NotRequired["capo_customer_profiles.types.string1_to255.string1To255"]
    """<p>The URI of the S3 bucket or any other type of data source.</p>"""
    object_type_name: NotRequired["capo_customer_profiles.types.type_name.typeName"]
    """<p>The name of the profile object type.</p>"""
    object_type_names: NotRequired[
        "capo_customer_profiles.types.object_type_names.ObjectTypeNames"
    ]
    """<p>A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an <code>ObjectTypeName</code> (template) used to ingest the event. It supports the following event types: <code>SegmentIdentify</code>, <code>ShopifyCreateCustomers</code>, <code>ShopifyUpdateCustomers</code>, <code>ShopifyCreateDraftOrders</code>, <code>ShopifyUpdateDraftOrders</code>, <code>ShopifyCreateOrders</code>, and <code>ShopifyUpdatedOrders</code>.</p>"""
    tags: NotRequired["capo_customer_profiles.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    flow_definition: NotRequired[
        "capo_customer_profiles.types.flow_definition.FlowDefinition"
    ]
    """<p>The configuration that controls how Customer Profiles retrieves data from the source.</p>"""
    role_arn: NotRequired["capo_customer_profiles.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.</p>"""
    event_trigger_names: NotRequired[
        "capo_customer_profiles.types.event_trigger_names.EventTriggerNames"
    ]
    """<p>A list of unique names for active event triggers associated with the integration.</p>"""
    scope: NotRequired["capo_customer_profiles.types.scope.Scope"]
    """<p>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.</p>"""

domain_name instance-attribute

domain_name: name

The unique name of the domain.

event_trigger_names instance-attribute

event_trigger_names: NotRequired[EventTriggerNames]

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

flow_definition instance-attribute

flow_definition: NotRequired[FlowDefinition]

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

object_type_name instance-attribute

object_type_name: NotRequired[typeName]

The name of the profile object type.

object_type_names instance-attribute

object_type_names: NotRequired[ObjectTypeNames]

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.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

scope instance-attribute

scope: NotRequired[Scope]

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.

tags instance-attribute

tags: NotRequired[TagMap]

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

uri instance-attribute

uri: NotRequired[string1To255]

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