EndUserMessaging / Paginator / ListBrandProfiles

ListBrandProfiles

class EndUserMessaging.Paginator.ListBrandProfiles

paginator = client.get_paginator('list_brand_profiles')

paginate(**kwargs)

Creates an iterator that will paginate through responses from EndUserMessaging.Client.list_brand_profiles().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'brandProfiles': [
        {
            'brandProfileId': 'string',
            'brandProfileArn': 'string',
            'brandProfileName': 'string',
            'status': 'ACTIVE'|'BLOCKED'|'PAUSED'|'CANCELLED'|'FAILED',
            'deletionProtectionEnabled': True|False,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • brandProfiles (list) –

    The list of brand profiles.

    • (dict) –

      Contains information about a brand profile.

      • brandProfileId (string) –

        The unique identifier of the brand profile.

      • brandProfileArn (string) –

        The Amazon Resource Name (ARN) of the brand profile.

      • brandProfileName (string) –

        The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

      • status (string) –

        The current lifecycle status of the brand profile.

      • deletionProtectionEnabled (boolean) –

        Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

      • createdAt (datetime) –

        The time when the resource was created, in Unix epoch time.

      • updatedAt (datetime) –

        The time when the resource was last updated, in Unix epoch time.

  • NextToken (string) –

    A token to resume pagination.