EndUserMessaging / Client / list_brand_profile_attributes

list_brand_profile_attributes¶

EndUserMessaging.Client.list_brand_profile_attributes(**kwargs)¶

Retrieves a paginated list of the attributes for a brand profile.

Request Syntax

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

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

{
    'brandProfileAttributes': [
        {
            'attributeName': 'string',
            'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
            'description': 'string',
            'category': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- brandProfileAttributes (list) –
  
  The list of brand profile attributes.
  - (dict) –
    
    Contains summary information about a brand profile attribute in a list response.
    - attributeName (string) –
      
      The name of the brand profile attribute. The name is unique within a brand profile.
    - attributeType (string) –
      
      The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
    - description (string) –
      
      A description of the attribute.
    - category (string) –
      
      The category of the attribute.
    - 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.ResourceNotFoundException
EndUserMessaging.Client.exceptions.InternalServerException