topics

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

Overview

Name	topics
Type	Resource
Id	aws.quicksight.topics

Fields

The following fields are returned by SELECT queries:

describe_topic

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the topic.
custom_instructions	object	Instructions that provide additional guidance and context for response generation.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
topic	object	A structure that describes the details of a topic, such as its name, description, and associated data sets.
topic_id	string	The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>^[A-Za-z0-9-_.\+]*$</code>)

search_topics

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the topic.
name	string	The name of the topic.
topic_id	string	The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>^[A-Za-z0-9-_.\+]*$</code>)
user_experience_version	string	The user experience version of the topic. (LEGACY, NEW_READER_EXPERIENCE)

list_topics

Name	Datatype	Description
next_token	string	The token for the next set of results, or null if there are no more results.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
topics_summaries	array	A list of topic summaries.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_topic	select	aws_account_id, topic_id, region		Describes a topic.
search_topics	select	aws_account_id, region		Searches for any Q topic that exists in an Quick account.
list_topics	select	aws_account_id, region	next-token, max-results	Lists all of the topics within an account.
create_topic	insert	aws_account_id, region, TopicId		Creates a new Q topic.
update_topic	update	aws_account_id, topic_id, region		Updates a topic.
delete_topic	delete	aws_account_id, topic_id, region		Deletes a topic.
batch_create_topic_reviewed_answer	exec	aws_account_id, topic_id, region, Answers		Creates new reviewed answers for a Q Topic.
batch_delete_topic_reviewed_answer	exec	aws_account_id, topic_id, region		Deletes reviewed answers for Q Topic.

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 you want to delete a reviewed answers in.
region	string	AWS region (default: us-east-1)
topic_id	string	The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
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.

SELECT examples

describe_topic

Describes a topic.

SELECT
arn,
custom_instructions,
request_id,
status,
topic,
topic_id
FROM aws.quicksight.topics
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND topic_id = '{{ topic_id }}' -- required
AND region = '{{ region }}' -- required
;

search_topics

Searches for any Q topic that exists in an Quick account.

SELECT
arn,
name,
topic_id,
user_experience_version
FROM aws.quicksight.topics
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
;

list_topics

Lists all of the topics within an account.

SELECT
next_token,
request_id,
status,
topics_summaries
FROM aws.quicksight.topics
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_topic

Creates a new Q topic.

INSERT INTO aws.quicksight.topics (
TopicId,
Topic,
Tags,
FolderArns,
CustomInstructions,
aws_account_id,
region
)
SELECT 
'{{ TopicId }}' /* required */,
'{{ Topic }}',
'{{ Tags }}',
'{{ FolderArns }}',
'{{ CustomInstructions }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
refresh_arn,
request_id,
status,
topic_id
;

Manifest

# Description fields are for documentation purposes
- name: topics
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the topics resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the topics resource.
  - name: TopicId
    value: "{{ TopicId }}"
  - name: Topic
    description: |
      A structure that describes the details of a topic, such as its name, description, and associated data sets.
    value:
      Name: "{{ Name }}"
      Description: "{{ Description }}"
      UserExperienceVersion: "{{ UserExperienceVersion }}"
      DataSets:
        - DatasetArn: "{{ DatasetArn }}"
          DatasetName: "{{ DatasetName }}"
          DatasetDescription: "{{ DatasetDescription }}"
          DataAggregation:
            DatasetRowDateGranularity: "{{ DatasetRowDateGranularity }}"
            DefaultDateColumnName: "{{ DefaultDateColumnName }}"
          Filters: "{{ Filters }}"
          Columns: "{{ Columns }}"
          CalculatedFields: "{{ CalculatedFields }}"
          NamedEntities: "{{ NamedEntities }}"
      ConfigOptions:
        QBusinessInsightsEnabled: {{ QBusinessInsightsEnabled }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: FolderArns
    value:
      - "{{ FolderArns }}"
  - name: CustomInstructions
    description: |
      Instructions that provide additional guidance and context for response generation.
    value:
      CustomInstructionsString: "{{ CustomInstructionsString }}"

UPDATE examples

update_topic

Updates a topic.

UPDATE aws.quicksight.topics
SET 
Topic = '{{ Topic }}',
CustomInstructions = '{{ CustomInstructions }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND topic_id = '{{ topic_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
refresh_arn,
request_id,
status,
topic_id;

DELETE examples

delete_topic

Deletes a topic.

DELETE FROM aws.quicksight.topics
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND topic_id = '{{ topic_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

batch_create_topic_reviewed_answer

Creates new reviewed answers for a Q Topic.

EXEC aws.quicksight.topics.batch_create_topic_reviewed_answer 
@aws_account_id='{{ aws_account_id }}' --required, 
@topic_id='{{ topic_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"Answers": "{{ Answers }}"
}'
;

batch_delete_topic_reviewed_answer

Deletes reviewed answers for Q Topic.

EXEC aws.quicksight.topics.batch_delete_topic_reviewed_answer 
@aws_account_id='{{ aws_account_id }}' --required, 
@topic_id='{{ topic_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"AnswerIds": "{{ AnswerIds }}"
}'
;