EndUserMessaging / Client / update_brand_profile_attribute

update_brand_profile_attribute

EndUserMessaging.Client.update_brand_profile_attribute(**kwargs)

Updates the value, description, or category of an existing brand profile attribute.

See also: AWS API Documentation

Request Syntax

response = client.update_brand_profile_attribute(
    brandProfileId='string',
    attributeName='string',
    attributeValue='string',
    attachmentBody=b'bytes',
    description='string',
    category='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.

  • attributeValue (string) – The text value of the attribute. This value applies to attributes of type TEXT.

  • attachmentBody (bytes) – The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

  • description (string) – A description of the attribute.

  • category (string) – The category of the attribute.

Return type:

dict

Returns:

Response Syntax

{
    'attributeName': 'string',
    'attributeType': 'TEXT'|'IMAGE'|'DOCUMENT',
    'attributeValue': 'string',
    'description': 'string',
    'category': 'string',
    'mediaContentType': 'string',
    'mediaSizeBytes': 123,
    '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.

    • 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

  • EndUserMessaging.Client.exceptions.ConflictException