EndUserMessaging / Client / list_brand_profiles

list_brand_profiles¶

EndUserMessaging.Client.list_brand_profiles(**kwargs)¶

Retrieves a paginated list of the brand profiles in your account. Use the nextToken parameter to retrieve additional results.

Request Syntax

response = client.list_brand_profiles(
    nextToken='string',
    maxResults=123
)

Parameters:

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.
maxResults (integer) – The maximum number of results to return per page.

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

EndUserMessaging.Client.exceptions.ValidationException
EndUserMessaging.Client.exceptions.ThrottlingException
EndUserMessaging.Client.exceptions.AccessDeniedException
EndUserMessaging.Client.exceptions.InternalServerException