CustomerProfiles / Paginator / ListSegmentDefinitions

ListSegmentDefinitions

class CustomerProfiles.Paginator.ListSegmentDefinitions

paginator = client.get_paginator('list_segment_definitions')

paginate(**kwargs)

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

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 identifier 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': [
        {
            'SegmentDefinitionName': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'SegmentDefinitionArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • Items (list) –

    List of segment definitions.

    • (dict) –

      Object holding the segment definition fields.

      • SegmentDefinitionName (string) –

        Name of the segment definition.

      • DisplayName (string) –

        Display name of the segment definition.

      • Description (string) –

        The description of the segment definition.

      • SegmentDefinitionArn (string) –

        The arn of the segment definition.

      • CreatedAt (datetime) –

        When the segment definition was created.

      • Tags (dict) –

        The tags belonging to the segment definition.

        • (string) –

          • (string) –