topic_v2s

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

Overview

Name	topic_v2s
Type	Resource
Id	aws.quicksight.topic_v2s

Fields

The following fields are returned by SELECT queries:

describe_topic_v2

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	The definition of a topic.
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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_topic_v2	select	aws_account_id, topic_id, region		Describes a Q topic.
create_topic_v2	insert	aws_account_id, region, TopicId		Creates a new Q topic.
update_topic_v2	update	aws_account_id, topic_id, region		Updates the definition of a Q topic.
delete_topic_v2	delete	aws_account_id, topic_id, region		Deletes a 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 contains the topic that you want to delete.
region	string	AWS region (default: us-east-1)
topic_id	string	The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

SELECT examples

describe_topic_v2

Describes a Q topic.

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

INSERT examples

create_topic_v2

Creates a new Q topic.

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

Manifest

# Description fields are for documentation purposes
- name: topic_v2s
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the topic_v2s resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the topic_v2s resource.
  - name: TopicId
    value: "{{ TopicId }}"
  - name: Topic
    description: |
      The definition of a topic.
    value:
      Name: "{{ Name }}"
      Description: "{{ Description }}"
      DataSets:
        - DataSetArn: "{{ DataSetArn }}"
          DataSetName: "{{ DataSetName }}"
      DataSetRelations:
        - Left:
            DataSetArn: "{{ DataSetArn }}"
            ColumnNames:
              - "{{ ColumnNames }}"
          Right:
            DataSetArn: "{{ DataSetArn }}"
            ColumnNames:
              - "{{ ColumnNames }}"
  - 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_v2

Updates the definition of a Q topic.

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

DELETE examples

delete_topic_v2

Deletes a Q topic.

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