CustomerProfiles / Client / list_segment_definitions

list_segment_definitions#

CustomerProfiles.Client.list_segment_definitions(**kwargs)#

Lists all segment definitions under a domain.

See also: AWS API Documentation

Request Syntax

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

  • DomainName (string) –

    [REQUIRED]

    The unique identifier of the domain.

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

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Items': [
        {
            'SegmentDefinitionName': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'SegmentDefinitionArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The pagination token from the previous call.

    • 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) –

Exceptions