CustomerProfiles / Paginator / ListDomainLayouts

ListDomainLayouts

class CustomerProfiles.Paginator.ListDomainLayouts

paginator = client.get_paginator('list_domain_layouts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CustomerProfiles.Client.list_domain_layouts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DomainName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DomainName (string) –

  [REQUIRED]

  The unique name of the domain.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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)
        },
    ],

}

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.