QuickSight / Client / delete_brand

delete_brand

QuickSight.Client.delete_brand(**kwargs)

Warning

This API permanently deletes the specified Quick Sight brand. When you delete a brand:

  • The brand and all its associated branding elements are permanently removed

  • Any applications or dashboards using this brand will revert to default styling

  • This action cannot be undone through the API

Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.

Deletes an Quick Sight brand.

See also: AWS API Documentation

Request Syntax

response = client.delete_brand(
    AwsAccountId='string',
    BrandId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that owns the brand.

  • BrandId (string) –

    [REQUIRED]

    The ID of the QuickSight brand.

Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidRequestException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InternalServerException