topics_v2s

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

Overview

Name	topics_v2s
Type	Resource
Id	aws.quicksight.topics_v2s

Fields

The following fields are returned by SELECT queries:

search_topics_v2

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 of the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>^[A-Za-z0-9-_.\+]*$</code>)

list_topics_v2

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 of the topic. 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
search_topics_v2	select	aws_account_id, region		Searches for any Q topic that exists in an Amazon Web Services account.
list_topics_v2	select	aws_account_id, region	next-token, max-results	Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.

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 topics that you want to list.
region	string	AWS region (default: us-east-1)
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

search_topics_v2

Searches for any Q topic that exists in an Amazon Web Services account.

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

list_topics_v2

Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.

SELECT
arn,
name,
topic_id
FROM aws.quicksight.topics_v2s
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;