theme_alias

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

Overview

Name	theme_alias
Type	Resource
Id	aws.quicksight.theme_alias

Fields

The following fields are returned by SELECT queries:

describe_theme_alias

Name	Datatype	Description
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
theme_alias	object	Information about the theme alias.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_theme_alias	select	aws_account_id, theme_id, alias_name, region		Describes the alias for a theme.
create_theme_alias	insert	aws_account_id, theme_id, alias_name, region, ThemeVersionNumber		Creates a theme alias for a theme.
update_theme_alias	update	aws_account_id, theme_id, alias_name, region, ThemeVersionNumber		Updates an alias of a theme.
delete_theme_alias	delete	aws_account_id, theme_id, alias_name, region		Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

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
alias_name	string	The unique name for the theme alias to delete.
aws_account_id	string	The ID of the Amazon Web Services account that contains the theme alias to delete.
region	string	AWS region (default: us-east-1)
theme_id	string	The ID for the theme that the specified alias is for.

SELECT examples

describe_theme_alias

Describes the alias for a theme.

SELECT
request_id,
status,
theme_alias
FROM aws.quicksight.theme_alias
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND theme_id = '{{ theme_id }}' -- required
AND alias_name = '{{ alias_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_theme_alias

Creates a theme alias for a theme.

INSERT INTO aws.quicksight.theme_alias (
ThemeVersionNumber,
aws_account_id,
theme_id,
alias_name,
region
)
SELECT 
{{ ThemeVersionNumber }} /* required */,
'{{ aws_account_id }}',
'{{ theme_id }}',
'{{ alias_name }}',
'{{ region }}'
RETURNING
request_id,
status,
theme_alias
;

Manifest

# Description fields are for documentation purposes
- name: theme_alias
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the theme_alias resource.
  - name: theme_id
    value: "{{ theme_id }}"
    description: Required parameter for the theme_alias resource.
  - name: alias_name
    value: "{{ alias_name }}"
    description: Required parameter for the theme_alias resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the theme_alias resource.
  - name: ThemeVersionNumber
    value: {{ ThemeVersionNumber }}

UPDATE examples

update_theme_alias

Updates an alias of a theme.

UPDATE aws.quicksight.theme_alias
SET 
ThemeVersionNumber = {{ ThemeVersionNumber }}
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND theme_id = '{{ theme_id }}' --required
AND alias_name = '{{ alias_name }}' --required
AND region = '{{ region }}' --required
AND ThemeVersionNumber = '{{ ThemeVersionNumber }}' --required
RETURNING
request_id,
status,
theme_alias;

DELETE examples

delete_theme_alias

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

DELETE FROM aws.quicksight.theme_alias
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND theme_id = '{{ theme_id }}' --required
AND alias_name = '{{ alias_name }}' --required
AND region = '{{ region }}' --required
;