topics

Creates, updates, deletes or gets a topic resource or lists topics in a region

Overview

Name	topics
Type	Resource
Description	Definition of the AWS::QuickSight::Topic Resource Type.
Id	awscc.quicksight.topics

Fields

get (all properties)

Name	Datatype	Description
arn	string
aws_account_id	string
▶config_options	object	Model for configuration of a Topic
▶custom_instructions	object
▶data_sets	array
description	string
folder_arns	array
name	string
▶tags	array
topic_id	string
user_experience_version	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
aws_account_id	string
topic_id	string
region	string	AWS region.

For more information, see AWS::QuickSight::Topic.

Methods

Name	Resource	Accessible by	Required Params
create_resource	topics	INSERT	region
delete_resource	topics	DELETE	Identifier, region
update_resource	topics	UPDATE	Identifier, PatchDocument, region
list_resources	topics_list_only	SELECT	region
get_resource	topics	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual topic.

SELECT
  region,
  arn,
  aws_account_id,
  config_options,
  custom_instructions,
  data_sets,
  description,
  folder_arns,
  name,
  tags,
  topic_id,
  user_experience_version
FROM awscc.quicksight.topics
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ aws_account_id }}|{{ topic_id }}';

list (identifiers only)

Lists all topics in a region.

SELECT
  region,
  aws_account_id,
  topic_id
FROM awscc.quicksight.topics_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.quicksight.topics (
  AwsAccountId,
  ConfigOptions,
  CustomInstructions,
  DataSets,
  Description,
  FolderArns,
  Name,
  Tags,
  TopicId,
  UserExperienceVersion,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ config_options }}',
  '{{ custom_instructions }}',
  '{{ data_sets }}',
  '{{ description }}',
  '{{ folder_arns }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ topic_id }}',
  '{{ user_experience_version }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.quicksight.topics (
  AwsAccountId,
  ConfigOptions,
  CustomInstructions,
  DataSets,
  Description,
  FolderArns,
  Name,
  Tags,
  TopicId,
  UserExperienceVersion,
  region
)
SELECT
  '{{ aws_account_id }}',
  '{{ config_options }}',
  '{{ custom_instructions }}',
  '{{ data_sets }}',
  '{{ description }}',
  '{{ folder_arns }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ topic_id }}',
  '{{ user_experience_version }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: topic
    props:
      - name: aws_account_id
        value: '{{ aws_account_id }}'
      - name: config_options
        value:
          q_business_insights_enabled: '{{ q_business_insights_enabled }}'
      - name: custom_instructions
        value:
          custom_instructions_string: '{{ custom_instructions_string }}'
      - name: data_sets
        value:
          - dataset_arn: '{{ dataset_arn }}'
            dataset_name: '{{ dataset_name }}'
            dataset_description: '{{ dataset_description }}'
            data_aggregation:
              dataset_row_date_granularity: '{{ dataset_row_date_granularity }}'
              default_date_column_name: '{{ default_date_column_name }}'
            filters:
              - filter_description: '{{ filter_description }}'
                filter_class: '{{ filter_class }}'
                filter_name: '{{ filter_name }}'
                filter_synonyms:
                  - '{{ filter_synonyms[0] }}'
                operand_field_name: '{{ operand_field_name }}'
                filter_type: '{{ filter_type }}'
                category_filter:
                  category_filter_function: '{{ category_filter_function }}'
                  category_filter_type: '{{ category_filter_type }}'
                  constant:
                    constant_type: '{{ constant_type }}'
                    singular_constant: '{{ singular_constant }}'
                    collective_constant:
                      value_list:
                        - '{{ value_list[0] }}'
                  inverse: '{{ inverse }}'
                numeric_equality_filter:
                  constant:
                    constant_type: null
                    singular_constant: '{{ singular_constant }}'
                  aggregation: '{{ aggregation }}'
                numeric_range_filter:
                  inclusive: '{{ inclusive }}'
                  constant:
                    constant_type: null
                    range_constant:
                      minimum: '{{ minimum }}'
                      maximum: '{{ maximum }}'
                  aggregation: null
                date_range_filter:
                  inclusive: '{{ inclusive }}'
                  constant: null
                relative_date_filter:
                  time_granularity: null
                  relative_date_filter_function: '{{ relative_date_filter_function }}'
                  constant: null
            columns:
              - column_name: '{{ column_name }}'
                column_friendly_name: '{{ column_friendly_name }}'
                column_description: '{{ column_description }}'
                column_synonyms:
                  - '{{ column_synonyms[0] }}'
                column_data_role: '{{ column_data_role }}'
                aggregation: '{{ aggregation }}'
                is_included_in_topic: '{{ is_included_in_topic }}'
                disable_indexing: '{{ disable_indexing }}'
                comparative_order:
                  use_ordering: '{{ use_ordering }}'
                  specifed_order:
                    - '{{ specifed_order[0] }}'
                  treat_undefined_specified_values: '{{ treat_undefined_specified_values }}'
                semantic_type:
                  type_name: '{{ type_name }}'
                  sub_type_name: '{{ sub_type_name }}'
                  type_parameters: {}
                  truthy_cell_value: '{{ truthy_cell_value }}'
                  truthy_cell_value_synonyms:
                    - '{{ truthy_cell_value_synonyms[0] }}'
                  falsey_cell_value: '{{ falsey_cell_value }}'
                  falsey_cell_value_synonyms:
                    - '{{ falsey_cell_value_synonyms[0] }}'
                time_granularity: null
                allowed_aggregations:
                  - '{{ allowed_aggregations[0] }}'
                not_allowed_aggregations:
                  - null
                default_formatting:
                  display_format: '{{ display_format }}'
                  display_format_options:
                    use_blank_cell_format: '{{ use_blank_cell_format }}'
                    blank_cell_format: '{{ blank_cell_format }}'
                    date_format: '{{ date_format }}'
                    decimal_separator: '{{ decimal_separator }}'
                    grouping_separator: '{{ grouping_separator }}'
                    use_grouping: '{{ use_grouping }}'
                    fraction_digits: null
                    prefix: '{{ prefix }}'
                    suffix: '{{ suffix }}'
                    unit_scaler: '{{ unit_scaler }}'
                    negative_format:
                      prefix: '{{ prefix }}'
                      suffix: '{{ suffix }}'
                    currency_symbol: '{{ currency_symbol }}'
                never_aggregate_in_filter: '{{ never_aggregate_in_filter }}'
                cell_value_synonyms:
                  - cell_value: '{{ cell_value }}'
                    synonyms:
                      - '{{ synonyms[0] }}'
                non_additive: '{{ non_additive }}'
            calculated_fields:
              - calculated_field_name: '{{ calculated_field_name }}'
                calculated_field_description: '{{ calculated_field_description }}'
                expression: '{{ expression }}'
                calculated_field_synonyms:
                  - '{{ calculated_field_synonyms[0] }}'
                is_included_in_topic: '{{ is_included_in_topic }}'
                disable_indexing: '{{ disable_indexing }}'
                column_data_role: null
                time_granularity: null
                default_formatting: null
                aggregation: null
                comparative_order: null
                semantic_type: null
                allowed_aggregations:
                  - null
                not_allowed_aggregations:
                  - null
                never_aggregate_in_filter: '{{ never_aggregate_in_filter }}'
                cell_value_synonyms:
                  - null
                non_additive: '{{ non_additive }}'
            named_entities:
              - entity_name: '{{ entity_name }}'
                entity_description: '{{ entity_description }}'
                entity_synonyms:
                  - '{{ entity_synonyms[0] }}'
                semantic_entity_type:
                  type_name: '{{ type_name }}'
                  sub_type_name: '{{ sub_type_name }}'
                  type_parameters: null
                definition:
                  - field_name: '{{ field_name }}'
                    property_name: '{{ property_name }}'
                    property_role: '{{ property_role }}'
                    property_usage: '{{ property_usage }}'
                    metric:
                      aggregation: '{{ aggregation }}'
                      aggregation_function_parameters: {}
      - name: description
        value: '{{ description }}'
      - name: folder_arns
        value:
          - '{{ folder_arns[0] }}'
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: topic_id
        value: '{{ topic_id }}'
      - name: user_experience_version
        value: '{{ user_experience_version }}'

UPDATE example

Use the following StackQL query and manifest file to update a topic resource, using stack-deploy.

/*+ update */
UPDATE awscc.quicksight.topics
SET PatchDocument = string('{{ {
    "ConfigOptions": config_options,
    "CustomInstructions": custom_instructions,
    "DataSets": data_sets,
    "Description": description,
    "Name": name,
    "UserExperienceVersion": user_experience_version
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aws_account_id }}|{{ topic_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.quicksight.topics
WHERE
  Identifier = '{{ aws_account_id }}|{{ topic_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

quicksight:CreateTopic,
quicksight:PassDataSet,
quicksight:DescribeTopicRefresh,
quicksight:TagResource

Read

quicksight:DescribeTopic,
quicksight:ListTagsForResource

Update

quicksight:UpdateTopic,
quicksight:PassDataSet,
quicksight:DescribeTopicRefresh

Delete

quicksight:DeleteTopic

List

quicksight:ListTopics