CustomerProfiles / Client / list_integrations

list_integrations#

CustomerProfiles.Client.list_integrations(**kwargs)#

Lists all of the integrations in your domain.

See also: AWS API Documentation

Request Syntax

response = client.list_integrations(
    DomainName='string',
    NextToken='string',
    MaxResults=123,
    IncludeHidden=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • NextToken (string) – The pagination token from the previous ListIntegrations API call.

  • MaxResults (integer) – The maximum number of objects returned per page.

  • IncludeHidden (boolean) – Boolean to indicate if hidden integration should be returned. Defaults to False.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'DomainName': 'string',
            'Uri': 'string',
            'ObjectTypeName': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            },
            'ObjectTypeNames': {
                'string': 'string'
            },
            'WorkflowId': 'string',
            'IsUnstructured': True|False,
            'RoleArn': 'string',
            'EventTriggerNames': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      The list of ListIntegrations instances.

      • (dict) –

        An integration in list of integrations.

        • DomainName (string) –

          The unique name of the domain.

        • Uri (string) –

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

        • ObjectTypeName (string) –

          The name of the profile object type.

        • CreatedAt (datetime) –

          The timestamp of when the domain was created.

        • LastUpdatedAt (datetime) –

          The timestamp of when the domain was most recently edited.

        • Tags (dict) –

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

          • (string) –

            • (string) –

        • ObjectTypeNames (dict) –

          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.

          • (string) –

            • (string) –

        • WorkflowId (string) –

          Unique identifier for the workflow.

        • IsUnstructured (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.

        • RoleArn (string) –

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

        • EventTriggerNames (list) –

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

          • (string) –

    • NextToken (string) –

      The pagination token from the previous ListIntegrations API call.

Exceptions

  • CustomerProfiles.Client.exceptions.BadRequestException

  • CustomerProfiles.Client.exceptions.ResourceNotFoundException

  • CustomerProfiles.Client.exceptions.AccessDeniedException

  • CustomerProfiles.Client.exceptions.ThrottlingException

  • CustomerProfiles.Client.exceptions.InternalServerException