EndUserMessaging / Client / list_registrations_from_brand_profile

list_registrations_from_brand_profile

EndUserMessaging.Client.list_registrations_from_brand_profile(**kwargs)

Retrieves a paginated list of the registrations that were created from a brand profile through the synchronization operations.

See also: AWS API Documentation

Request Syntax

response = client.list_registrations_from_brand_profile(
    brandProfileId='string',
    maxResults=123,
    nextToken='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).

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

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

      The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

Exceptions