CustomerProfiles / Client / list_domain_layouts

list_domain_layouts

CustomerProfiles.Client.list_domain_layouts(**kwargs)

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_layouts(
    DomainName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • NextToken (string) – Identifies the next page of results to return.

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

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'LayoutDefinitionName': 'string',
            'Description': 'string',
            'DisplayName': 'string',
            'IsDefault': True|False,
            'LayoutType': 'PROFILE_EXPLORER',
            'Tags': {
                'string': 'string'
            },
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Items (list) –

      Contains summary information about an EventStream.

      • (dict) –

        The layout object that contains LayoutDefinitionName, Description, DisplayName, IsDefault, LayoutType, Tags, CreatedAt, LastUpdatedAt

        • LayoutDefinitionName (string) –

          The unique name of the layout.

        • Description (string) –

          The description of the layout

        • DisplayName (string) –

          The display name of the layout

        • IsDefault (boolean) –

          If set to true for a layout, this layout will be used by default to view data. If set to false, then layout will not be used by default but it can be used to view data by explicit selection on UI.

        • LayoutType (string) –

          The type of layout that can be used to view data under customer profiles domain.

        • Tags (dict) –

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

          • (string) –

            • (string) –

        • CreatedAt (datetime) –

          The timestamp of when the layout was created.

        • LastUpdatedAt (datetime) –

          The timestamp of when the layout was most recently updated.

    • NextToken (string) –

      Identifies the next page of results to return.

Exceptions