themes

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

Overview

Name	themes
Type	Resource
Id	aws.quicksight.themes

Fields

The following fields are returned by SELECT queries:

describe_theme

Name	Datatype	Description
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
theme	object	The information about the theme that you are describing.

list_themes

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the resource.
created_time	string (date-time)	The date and time that this theme was created.
last_updated_time	string (date-time)	The last date and time that this theme was updated.
latest_version_number	integer (int64)	The latest version number for the theme.
name	string	the display name for the theme.
theme_id	string	The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>[\w-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_theme	select	aws_account_id, theme_id, region	version-number, alias-name	Describes a theme.
list_themes	select	aws_account_id, region	next-token, max-results, type	Lists all the themes in the current Amazon Web Services account.
create_theme	insert	aws_account_id, theme_id, region, BaseThemeId, Configuration		Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.
update_theme	update	aws_account_id, theme_id, region, BaseThemeId		Updates a theme.
delete_theme	delete	aws_account_id, theme_id, region	version-number	Deletes a theme.

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 contains the theme that you're deleting.
region	string	AWS region (default: us-east-1)
theme_id	string	An ID for the theme that you want to delete.
alias-name	string	The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.
max-results	integer	The maximum number of results to be returned per request.
next-token	string	The token for the next set of results, or null if there are no more results.
type	string	The type of themes that you want to list. Valid options include the following: ALL (default)- Display all existing themes. CUSTOM - Display only the themes created by people using Amazon Quick Sight. QUICKSIGHT - Display only the starting themes defined by Quick Sight.
version-number	integer (int64)	The version of the theme that you want to delete. Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.

SELECT examples

describe_theme

Describes a theme.

SELECT
request_id,
status,
theme
FROM aws.quicksight.themes
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND theme_id = '{{ theme_id }}' -- required
AND region = '{{ region }}' -- required
AND `version-number` = '{{ version-number }}'
AND `alias-name` = '{{ alias-name }}'
;

list_themes

Lists all the themes in the current Amazon Web Services account.

SELECT
arn,
created_time,
last_updated_time,
latest_version_number,
name,
theme_id
FROM aws.quicksight.themes
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
AND type = '{{ type }}'
;

INSERT examples

create_theme

Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sight in the Amazon Quick Sight User Guide.

INSERT INTO aws.quicksight.themes (
Name,
BaseThemeId,
VersionDescription,
Configuration,
Permissions,
Tags,
aws_account_id,
theme_id,
region
)
SELECT 
'{{ Name }}',
'{{ BaseThemeId }}' /* required */,
'{{ VersionDescription }}',
'{{ Configuration }}' /* required */,
'{{ Permissions }}',
'{{ Tags }}',
'{{ aws_account_id }}',
'{{ theme_id }}',
'{{ region }}'
RETURNING
arn,
creation_status,
request_id,
status,
theme_id,
version_arn
;

Manifest

# Description fields are for documentation purposes
- name: themes
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the themes resource.
  - name: theme_id
    value: "{{ theme_id }}"
    description: Required parameter for the themes resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the themes resource.
  - name: Name
    value: "{{ Name }}"
  - name: BaseThemeId
    value: "{{ BaseThemeId }}"
  - name: VersionDescription
    value: "{{ VersionDescription }}"
  - name: Configuration
    description: |
      The theme configuration. This configuration contains all of the display properties for a theme.
    value:
      DataColorPalette:
        Colors:
          - "{{ Colors }}"
        MinMaxGradient:
          - "{{ MinMaxGradient }}"
        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:
          BackgroundColor: "{{ BackgroundColor }}"
          Border:
            Color: "{{ Color }}"
            Show: {{ Show }}
            Width: "{{ Width }}"
          BorderRadius: "{{ BorderRadius }}"
          Padding: "{{ Padding }}"
        TileLayout:
          Gutter:
            Show: {{ Show }}
          Margin:
            Show: {{ Show }}
        Background:
          Color: "{{ Color }}"
          Gradient: "{{ Gradient }}"
      Typography:
        FontFamilies:
          - FontFamily: "{{ FontFamily }}"
        AxisTitleFontConfiguration:
          FontSize:
            Relative: "{{ Relative }}"
            Absolute: "{{ Absolute }}"
          FontDecoration: "{{ FontDecoration }}"
          FontColor: "{{ FontColor }}"
          FontWeight:
            Name: "{{ Name }}"
          FontStyle: "{{ FontStyle }}"
          FontFamily: "{{ FontFamily }}"
        AxisLabelFontConfiguration:
          FontSize:
            Relative: "{{ Relative }}"
            Absolute: "{{ Absolute }}"
          FontDecoration: "{{ FontDecoration }}"
          FontColor: "{{ FontColor }}"
          FontWeight:
            Name: "{{ Name }}"
          FontStyle: "{{ FontStyle }}"
          FontFamily: "{{ FontFamily }}"
        LegendTitleFontConfiguration:
          FontSize:
            Relative: "{{ Relative }}"
            Absolute: "{{ Absolute }}"
          FontDecoration: "{{ FontDecoration }}"
          FontColor: "{{ FontColor }}"
          FontWeight:
            Name: "{{ Name }}"
          FontStyle: "{{ FontStyle }}"
          FontFamily: "{{ FontFamily }}"
        LegendValueFontConfiguration:
          FontSize:
            Relative: "{{ Relative }}"
            Absolute: "{{ Absolute }}"
          FontDecoration: "{{ FontDecoration }}"
          FontColor: "{{ FontColor }}"
          FontWeight:
            Name: "{{ Name }}"
          FontStyle: "{{ FontStyle }}"
          FontFamily: "{{ FontFamily }}"
        DataLabelFontConfiguration:
          FontSize:
            Relative: "{{ Relative }}"
            Absolute: "{{ Absolute }}"
          FontDecoration: "{{ FontDecoration }}"
          FontColor: "{{ FontColor }}"
          FontWeight:
            Name: "{{ Name }}"
          FontStyle: "{{ FontStyle }}"
          FontFamily: "{{ FontFamily }}"
        VisualTitleFontConfiguration:
          FontConfiguration:
            FontSize:
              Relative: "{{ Relative }}"
              Absolute: "{{ Absolute }}"
            FontDecoration: "{{ FontDecoration }}"
            FontColor: "{{ FontColor }}"
            FontWeight:
              Name: "{{ Name }}"
            FontStyle: "{{ FontStyle }}"
            FontFamily: "{{ FontFamily }}"
          TextAlignment: "{{ TextAlignment }}"
          TextTransform: "{{ TextTransform }}"
        VisualSubtitleFontConfiguration:
          FontConfiguration:
            FontSize:
              Relative: "{{ Relative }}"
              Absolute: "{{ Absolute }}"
            FontDecoration: "{{ FontDecoration }}"
            FontColor: "{{ FontColor }}"
            FontWeight:
              Name: "{{ Name }}"
            FontStyle: "{{ FontStyle }}"
            FontFamily: "{{ FontFamily }}"
          TextAlignment: "{{ TextAlignment }}"
          TextTransform: "{{ TextTransform }}"
        ControlTitleFontConfiguration:
          FontConfiguration:
            FontSize:
              Relative: "{{ Relative }}"
              Absolute: "{{ Absolute }}"
            FontDecoration: "{{ FontDecoration }}"
            FontColor: "{{ FontColor }}"
            FontWeight:
              Name: "{{ Name }}"
            FontStyle: "{{ FontStyle }}"
            FontFamily: "{{ FontFamily }}"
          TextAlignment: "{{ TextAlignment }}"
  - name: Permissions
    value:
      - Principal: "{{ Principal }}"
        Actions: "{{ Actions }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_theme

Updates a theme.

UPDATE aws.quicksight.themes
SET 
Name = '{{ Name }}',
BaseThemeId = '{{ BaseThemeId }}',
VersionDescription = '{{ VersionDescription }}',
Configuration = '{{ Configuration }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND theme_id = '{{ theme_id }}' --required
AND region = '{{ region }}' --required
AND BaseThemeId = '{{ BaseThemeId }}' --required
RETURNING
arn,
creation_status,
request_id,
status,
theme_id,
version_arn;

DELETE examples

delete_theme

Deletes a theme.

DELETE FROM aws.quicksight.themes
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND theme_id = '{{ theme_id }}' --required
AND region = '{{ region }}' --required
AND `version-number` = '{{ version-number }}'
;