EndUserMessaging / Paginator / ListRegistrationsFromBrandProfile

ListRegistrationsFromBrandProfile

class EndUserMessaging.Paginator.ListRegistrationsFromBrandProfile

paginator = client.get_paginator('list_registrations_from_brand_profile')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• brandProfileId (string) –

  [REQUIRED]

  The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

• 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

{
    'registrationAssociations': [
        {
            'registrationId': 'string',
            'registrationType': 'string',
            'createdAt': datetime(2015, 1, 1),
            'smartMatchUsed': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • registrationAssociations (list) –

    The list of registrations that are associated with the brand profile.

    • (dict) –

      Contains summary information about a registration that is associated with a brand profile.

      • registrationId (string) –

        The identifier of the registration.

      • registrationType (string) –

        The type of the registration, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.

      • createdAt (datetime) –

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

      • smartMatchUsed (boolean) –

        Specifies whether smart matching was used to create the association.

  • NextToken (string) –

    A token to resume pagination.