brands

Creates, updates, deletes, gets or lists a brands resource.

Overview

Name	brands
Type	Resource
Id	aws.quicksight.brands

Fields

The following fields are returned by SELECT queries:

describe_brand

Name	Datatype	Description
brand_definition	object	The definition of the brand.
brand_detail	object	The details of the brand.
request_id	string	The Amazon Web Services request ID for this operation.

list_brands

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the brand.
brand_id	string	The ID of the Quick brand. (pattern: <code>[\w-]+</code>)
brand_name	string	The name of the brand. (pattern: <code>[ -ÿ]+</code>)
brand_status	string	The status of the brand. (CREATE_IN_PROGRESS, CREATE_SUCCEEDED, CREATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED)
created_time	string (date-time)	The time that the brand was created.
description	string	The description of the brand. (pattern: <code>[ -ÿ]+</code>)
last_updated_time	string (date-time)	The time when the brand was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_brand	select	aws_account_id, brand_id, region	versionId	Describes a brand.
list_brands	select	aws_account_id, region	max-results, next-token	Lists all brands in an Quick Sight account.
create_brand	insert	aws_account_id, brand_id, region		Creates an Quick Sight brand.
update_brand	update	aws_account_id, brand_id, region		Updates a brand.
delete_brand	delete	aws_account_id, brand_id, region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aws_account_id	string	The ID of the Amazon Web Services account that owns the brand.
brand_id	string	The ID of the Quick brand.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to be returned in a single request.
next-token	string	The token for the next set of results, or null if there are no more results.
versionId	string	The ID of the specific version. The default value is the latest version.

SELECT examples

describe_brand

Describes a brand.

SELECT
brand_definition,
brand_detail,
request_id
FROM aws.quicksight.brands
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND brand_id = '{{ brand_id }}' -- required
AND region = '{{ region }}' -- required
AND versionId = '{{ versionId }}'
;

list_brands

Lists all brands in an Quick Sight account.

SELECT
arn,
brand_id,
brand_name,
brand_status,
created_time,
description,
last_updated_time
FROM aws.quicksight.brands
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_brand

Creates an Quick Sight brand.

INSERT INTO aws.quicksight.brands (
BrandDefinition,
Tags,
aws_account_id,
brand_id,
region
)
SELECT 
'{{ BrandDefinition }}',
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ brand_id }}',
'{{ region }}'
RETURNING
brand_definition,
brand_detail,
request_id
;

Manifest

# Description fields are for documentation purposes
- name: brands
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the brands resource.
  - name: brand_id
    value: "{{ brand_id }}"
    description: Required parameter for the brands resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the brands resource.
  - name: BrandDefinition
    description: |
      The definition of the brand.
    value:
      BrandName: "{{ BrandName }}"
      Description: "{{ Description }}"
      ApplicationTheme:
        BrandColorPalette:
          Primary:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Secondary:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Accent:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Measure:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Dimension:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Success:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Info:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Warning:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Danger:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
        ContextualAccentPalette:
          Connection:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Visualization:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Insight:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
          Automation:
            Foreground: "{{ Foreground }}"
            Background: "{{ Background }}"
        BrandElementStyle:
          NavbarStyle:
            GlobalNavbar:
              Foreground: "{{ Foreground }}"
              Background: "{{ Background }}"
            ContextualNavbar:
              Foreground: "{{ Foreground }}"
              Background: "{{ Background }}"
      LogoConfiguration:
        AltText: "{{ AltText }}"
        LogoSet:
          Primary:
            Original:
              Source: "{{ Source }}"
          Favicon:
            Original:
              Source: "{{ Source }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_brand

Updates a brand.

UPDATE aws.quicksight.brands
SET 
BrandDefinition = '{{ BrandDefinition }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND brand_id = '{{ brand_id }}' --required
AND region = '{{ region }}' --required
RETURNING
brand_definition,
brand_detail,
request_id;

DELETE examples

delete_brand

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.

DELETE FROM aws.quicksight.brands
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND brand_id = '{{ brand_id }}' --required
AND region = '{{ region }}' --required
;