EndUserMessaging / Client / create_brand_profile

create_brand_profile

EndUserMessaging.Client.create_brand_profile(**kwargs)

Creates a brand profile. A brand profile is a lightweight container that holds your brand identity information as flexible attributes. After you create a brand profile, use the CreateBrandProfileAttributes operation to add company information, addresses, compliance documents, and logos.

See also: AWS API Documentation

Request Syntax

response = client.create_brand_profile(
    brandProfileName='string',
    clientToken='string',
    deletionProtectionEnabled=True|False,
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

Parameters:

• brandProfileName (string) –

  [REQUIRED]

  The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

• clientToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

  This field is autopopulated if not provided.

• deletionProtectionEnabled (boolean) – Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

• tags (list) –

  An array of key and value pair tags that are associated with the resource.

  • (dict) –

    Describes a tag as a key and value pair that you can associate with a resource.

    • key (string) – [REQUIRED]

      The key of the tag.

    • value (string) – [REQUIRED]

      The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    '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),
    'attributesCreated': 123
}

Response Structure

• (dict) –

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

  • attributesCreated (integer) –

    The number of default attributes that were created for the brand profile.

Exceptions

• EndUserMessaging.Client.exceptions.ValidationException

• EndUserMessaging.Client.exceptions.ThrottlingException

• EndUserMessaging.Client.exceptions.AccessDeniedException

• EndUserMessaging.Client.exceptions.InternalServerException

• EndUserMessaging.Client.exceptions.ConflictException

• EndUserMessaging.Client.exceptions.ServiceQuotaExceededException