Skip to main content

topic_refreshes

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

Overview​

Nametopic_refreshes
TypeResource
Idaws.quicksight.topic_refreshes

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
refresh_detailsobjectDetails of the refresh, which is performed when the topic is created or updated.
request_idstringThe Amazon Web Services request ID for this operation.
statusintegerThe HTTP status of the request.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_topic_refreshselectaws_account_id, topic_id, refresh_id, regionDescribes the status of a topic refresh.

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.

NameDatatypeDescription
aws_account_idstringThe ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.
refresh_idstringThe ID of the refresh, which is performed when the topic is created or updated.
regionstringAWS region (default: us-east-1)
topic_idstringThe ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

SELECT examples​

Describes the status of a topic refresh.

SELECT
refresh_details,
request_id,
status
FROM aws.quicksight.topic_refreshes
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND topic_id = '{{ topic_id }}' -- required
AND refresh_id = '{{ refresh_id }}' -- required
AND region = '{{ region }}' -- required
;