EndUserMessaging / Client / get_brand_profile_attribute

get_brand_profile_attribute¶

EndUserMessaging.Client.get_brand_profile_attribute(**kwargs)¶

Retrieves a single brand profile attribute.

Request Syntax

response = client.get_brand_profile_attribute(
    brandProfileId='string',
    attributeName='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).
attributeName (string) –
[REQUIRED]

The name of the brand profile attribute. The name is unique within a brand profile.

Return type:

dict

Returns:

Response Syntax

{
    'attributeName': 'string',
    'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
    'attributeValue': 'string',
    'description': 'string',
    'category': 'string',
    'mediaContentType': 'string',
    'mediaSizeBytes': 123,
    'mediaDownloadUrl': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- 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.
- attributeValue (string) –
  
  The text value of the attribute. This value applies to attributes of type TEXT.
- description (string) –
  
  A description of the attribute.
- category (string) –
  
  The category of the attribute.
- mediaContentType (string) –
  
  The MIME content type of the attribute media.
- mediaSizeBytes (integer) –
  
  The size of the attribute media, in bytes.
- mediaDownloadUrl (string) –
  
  A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.
- 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.

Exceptions

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