themes

Creates, updates, deletes or gets a theme resource or lists themes in a region

Overview

Name	themes
Type	Resource
Description	Definition of the AWS::QuickSight::Theme Resource Type.
Id	aws.quicksight.themes

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the theme.
aws_account_id	string
base_theme_id	string
configuration	object	The theme configuration. This configuration contains all of the display properties for a theme.
created_time	string	The date and time that the theme was created.
last_updated_time	string	The date and time that the theme was last updated.
name	string
permissions	array
tags	array
theme_id	string
type	string
version	object	A version of a theme.
version_description	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AwsAccountId, ThemeId, BaseThemeId, Configuration, Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all themes in a region.

SELECT
region,
arn,
aws_account_id,
base_theme_id,
configuration,
created_time,
last_updated_time,
name,
permissions,
tags,
theme_id,
type,
version,
version_description
FROM aws.quicksight.themes
WHERE region = 'us-east-1';

Gets all properties from an individual theme.

SELECT
region,
arn,
aws_account_id,
base_theme_id,
configuration,
created_time,
last_updated_time,
name,
permissions,
tags,
theme_id,
type,
version,
version_description
FROM aws.quicksight.themes
WHERE region = 'us-east-1' AND data__Identifier = '<ThemeId>|<AwsAccountId>';

INSERT example

Use the following StackQL query and manifest file to create a new theme resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.quicksight.themes (
 AwsAccountId,
 BaseThemeId,
 Configuration,
 Name,
 ThemeId,
 region
)
SELECT 
'{{ AwsAccountId }}',
 '{{ BaseThemeId }}',
 '{{ Configuration }}',
 '{{ Name }}',
 '{{ ThemeId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.themes (
 AwsAccountId,
 BaseThemeId,
 Configuration,
 Name,
 Permissions,
 Tags,
 ThemeId,
 VersionDescription,
 region
)
SELECT 
 '{{ AwsAccountId }}',
 '{{ BaseThemeId }}',
 '{{ Configuration }}',
 '{{ Name }}',
 '{{ Permissions }}',
 '{{ Tags }}',
 '{{ ThemeId }}',
 '{{ VersionDescription }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: theme
    props:
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: BaseThemeId
        value: '{{ BaseThemeId }}'
      - name: Configuration
        value:
          DataColorPalette:
            Colors:
              - '{{ Colors[0] }}'
            MinMaxGradient:
              - '{{ MinMaxGradient[0] }}'
            EmptyFillColor: '{{ EmptyFillColor }}'
          UIColorPalette:
            PrimaryForeground: '{{ PrimaryForeground }}'
            PrimaryBackground: '{{ PrimaryBackground }}'
            SecondaryForeground: '{{ SecondaryForeground }}'
            SecondaryBackground: '{{ SecondaryBackground }}'
            Accent: '{{ Accent }}'
            AccentForeground: '{{ AccentForeground }}'
            Danger: '{{ Danger }}'
            DangerForeground: '{{ DangerForeground }}'
            Warning: '{{ Warning }}'
            WarningForeground: '{{ WarningForeground }}'
            Success: '{{ Success }}'
            SuccessForeground: '{{ SuccessForeground }}'
            Dimension: '{{ Dimension }}'
            DimensionForeground: '{{ DimensionForeground }}'
            Measure: '{{ Measure }}'
            MeasureForeground: '{{ MeasureForeground }}'
          Sheet:
            Tile:
              Border:
                Show: '{{ Show }}'
            TileLayout:
              Gutter:
                Show: '{{ Show }}'
              Margin:
                Show: '{{ Show }}'
          Typography:
            FontFamilies:
              - FontFamily: '{{ FontFamily }}'
      - name: Name
        value: '{{ Name }}'
      - name: Permissions
        value:
          - Principal: '{{ Principal }}'
            Actions:
              - '{{ Actions[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: ThemeId
        value: '{{ ThemeId }}'
      - name: VersionDescription
        value: '{{ VersionDescription }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.themes
WHERE data__Identifier = '<ThemeId|AwsAccountId>'
AND region = 'us-east-1';

Permissions

To operate on the themes resource, the following permissions are required:

Read

quicksight:DescribeTheme,
quicksight:DescribeThemePermissions,
quicksight:ListTagsForResource

Create

quicksight:DescribeTheme,
quicksight:DescribeThemePermissions,
quicksight:CreateTheme,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

List

quicksight:ListThemes

Update

quicksight:DescribeTheme,
quicksight:DescribeThemePermissions,
quicksight:UpdateTheme,
quicksight:UpdateThemePermissions,
quicksight:TagResource,
quicksight:UntagResource,
quicksight:ListTagsForResource

Delete

quicksight:DescribeTheme,
quicksight:DeleteTheme