EndUserMessaging / Client / update_brand_profile

update_brand_profile

EndUserMessaging.Client.update_brand_profile(**kwargs)

Updates the name or the deletion protection setting of a brand profile. To change the information that is stored in the profile, use the brand profile attribute operations.

See also: AWS API Documentation

Request Syntax

response = client.update_brand_profile(
    brandProfileId='string',
    brandProfileName='string',
    deletionProtectionEnabled=True|False
)
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).

  • brandProfileName (string) – The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

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

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

  • EndUserMessaging.Client.exceptions.ValidationException

  • EndUserMessaging.Client.exceptions.ThrottlingException

  • EndUserMessaging.Client.exceptions.AccessDeniedException

  • EndUserMessaging.Client.exceptions.ResourceNotFoundException

  • EndUserMessaging.Client.exceptions.InternalServerException

  • EndUserMessaging.Client.exceptions.ConflictException