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	aws.quicksight.topics

Fields

Name	Datatype	Description
arn	string
aws_account_id	string
data_sets	array
description	string
name	string
topic_id	string
user_experience_version	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 topics in a region.

SELECT
region,
arn,
aws_account_id,
data_sets,
description,
name,
topic_id,
user_experience_version
FROM aws.quicksight.topics
WHERE region = 'us-east-1';

Gets all properties from an individual topic.

SELECT
region,
arn,
aws_account_id,
data_sets,
description,
name,
topic_id,
user_experience_version
FROM aws.quicksight.topics
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<TopicId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.quicksight.topics (
 AwsAccountId,
 DataSets,
 Description,
 Name,
 TopicId,
 UserExperienceVersion,
 region
)
SELECT 
'{{ AwsAccountId }}',
 '{{ DataSets }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ TopicId }}',
 '{{ UserExperienceVersion }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.topics (
 AwsAccountId,
 DataSets,
 Description,
 Name,
 TopicId,
 UserExperienceVersion,
 region
)
SELECT 
 '{{ AwsAccountId }}',
 '{{ DataSets }}',
 '{{ Description }}',
 '{{ Name }}',
 '{{ TopicId }}',
 '{{ UserExperienceVersion }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: topic
    props:
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: DataSets
        value:
          - DatasetArn: '{{ DatasetArn }}'
            DatasetName: '{{ DatasetName }}'
            DatasetDescription: '{{ DatasetDescription }}'
            DataAggregation:
              DatasetRowDateGranularity: '{{ DatasetRowDateGranularity }}'
              DefaultDateColumnName: '{{ DefaultDateColumnName }}'
            Filters:
              - FilterDescription: '{{ FilterDescription }}'
                FilterClass: '{{ FilterClass }}'
                FilterName: '{{ FilterName }}'
                FilterSynonyms:
                  - '{{ FilterSynonyms[0] }}'
                OperandFieldName: '{{ OperandFieldName }}'
                FilterType: '{{ FilterType }}'
                CategoryFilter:
                  CategoryFilterFunction: '{{ CategoryFilterFunction }}'
                  CategoryFilterType: '{{ CategoryFilterType }}'
                  Constant:
                    ConstantType: '{{ ConstantType }}'
                    SingularConstant: '{{ SingularConstant }}'
                    CollectiveConstant:
                      ValueList:
                        - '{{ ValueList[0] }}'
                  Inverse: '{{ Inverse }}'
                NumericEqualityFilter:
                  Constant:
                    ConstantType: null
                    SingularConstant: '{{ SingularConstant }}'
                  Aggregation: '{{ Aggregation }}'
                NumericRangeFilter:
                  Inclusive: '{{ Inclusive }}'
                  Constant:
                    ConstantType: null
                    RangeConstant:
                      Minimum: '{{ Minimum }}'
                      Maximum: '{{ Maximum }}'
                  Aggregation: null
                DateRangeFilter:
                  Inclusive: '{{ Inclusive }}'
                  Constant: null
                RelativeDateFilter:
                  TimeGranularity: null
                  RelativeDateFilterFunction: '{{ RelativeDateFilterFunction }}'
                  Constant: null
            Columns:
              - ColumnName: '{{ ColumnName }}'
                ColumnFriendlyName: '{{ ColumnFriendlyName }}'
                ColumnDescription: '{{ ColumnDescription }}'
                ColumnSynonyms:
                  - '{{ ColumnSynonyms[0] }}'
                ColumnDataRole: '{{ ColumnDataRole }}'
                Aggregation: '{{ Aggregation }}'
                IsIncludedInTopic: '{{ IsIncludedInTopic }}'
                DisableIndexing: '{{ DisableIndexing }}'
                ComparativeOrder:
                  UseOrdering: '{{ UseOrdering }}'
                  SpecifedOrder:
                    - '{{ SpecifedOrder[0] }}'
                  TreatUndefinedSpecifiedValues: '{{ TreatUndefinedSpecifiedValues }}'
                SemanticType:
                  TypeName: '{{ TypeName }}'
                  SubTypeName: '{{ SubTypeName }}'
                  TypeParameters: {}
                  TruthyCellValue: '{{ TruthyCellValue }}'
                  TruthyCellValueSynonyms:
                    - '{{ TruthyCellValueSynonyms[0] }}'
                  FalseyCellValue: '{{ FalseyCellValue }}'
                  FalseyCellValueSynonyms:
                    - '{{ FalseyCellValueSynonyms[0] }}'
                TimeGranularity: null
                AllowedAggregations:
                  - '{{ AllowedAggregations[0] }}'
                NotAllowedAggregations:
                  - null
                DefaultFormatting:
                  DisplayFormat: '{{ DisplayFormat }}'
                  DisplayFormatOptions:
                    UseBlankCellFormat: '{{ UseBlankCellFormat }}'
                    BlankCellFormat: '{{ BlankCellFormat }}'
                    DateFormat: '{{ DateFormat }}'
                    DecimalSeparator: '{{ DecimalSeparator }}'
                    GroupingSeparator: '{{ GroupingSeparator }}'
                    UseGrouping: '{{ UseGrouping }}'
                    FractionDigits: null
                    Prefix: '{{ Prefix }}'
                    Suffix: '{{ Suffix }}'
                    UnitScaler: '{{ UnitScaler }}'
                    NegativeFormat:
                      Prefix: '{{ Prefix }}'
                      Suffix: '{{ Suffix }}'
                    CurrencySymbol: '{{ CurrencySymbol }}'
                NeverAggregateInFilter: '{{ NeverAggregateInFilter }}'
                CellValueSynonyms:
                  - CellValue: '{{ CellValue }}'
                    Synonyms:
                      - '{{ Synonyms[0] }}'
                NonAdditive: '{{ NonAdditive }}'
            CalculatedFields:
              - CalculatedFieldName: '{{ CalculatedFieldName }}'
                CalculatedFieldDescription: '{{ CalculatedFieldDescription }}'
                Expression: '{{ Expression }}'
                CalculatedFieldSynonyms:
                  - '{{ CalculatedFieldSynonyms[0] }}'
                IsIncludedInTopic: '{{ IsIncludedInTopic }}'
                DisableIndexing: '{{ DisableIndexing }}'
                ColumnDataRole: null
                TimeGranularity: null
                DefaultFormatting: null
                Aggregation: null
                ComparativeOrder: null
                SemanticType: null
                AllowedAggregations:
                  - null
                NotAllowedAggregations:
                  - null
                NeverAggregateInFilter: '{{ NeverAggregateInFilter }}'
                CellValueSynonyms:
                  - null
                NonAdditive: '{{ NonAdditive }}'
            NamedEntities:
              - EntityName: '{{ EntityName }}'
                EntityDescription: '{{ EntityDescription }}'
                EntitySynonyms:
                  - '{{ EntitySynonyms[0] }}'
                SemanticEntityType:
                  TypeName: '{{ TypeName }}'
                  SubTypeName: '{{ SubTypeName }}'
                  TypeParameters: null
                Definition:
                  - FieldName: '{{ FieldName }}'
                    PropertyName: '{{ PropertyName }}'
                    PropertyRole: '{{ PropertyRole }}'
                    PropertyUsage: '{{ PropertyUsage }}'
                    Metric:
                      Aggregation: '{{ Aggregation }}'
                      AggregationFunctionParameters: {}
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: TopicId
        value: '{{ TopicId }}'
      - name: UserExperienceVersion
        value: '{{ UserExperienceVersion }}'

DELETE example

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

Permissions

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

Create

quicksight:CreateTopic,
quicksight:PassDataSet,
quicksight:DescribeTopicRefresh

Read

quicksight:DescribeTopic

Update

quicksight:UpdateTopic,
quicksight:PassDataSet,
quicksight:DescribeTopicRefresh

Delete

quicksight:DeleteTopic

List

quicksight:ListTopics