EndUserMessaging / Client / get_brand_profile

get_brand_profile

EndUserMessaging.Client.get_brand_profile(**kwargs)

Retrieves the metadata for a brand profile, including its name, status, deletion protection setting, and timestamps. To retrieve the attributes of the profile, use the ListBrandProfileAttributes operation.

See also: AWS API Documentation

Request Syntax

response = client.get_brand_profile(
    brandProfileId='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).

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

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.

Exceptions