topic_refreshes
Creates, updates, deletes, gets or lists a topic_refreshes resource.
Overview
| Name | topic_refreshes |
| Type | Resource |
| Id | aws.quicksight.topic_refreshes |
Fields
The following fields are returned by SELECT queries:
- describe_topic_refresh
| Name | Datatype | Description |
|---|---|---|
refresh_details | object | Details of the refresh, which is performed when the topic is created or updated. |
request_id | string | The Amazon Web Services request ID for this operation. |
status | integer | The HTTP status of the request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_topic_refresh | select | aws_account_id, topic_id, refresh_id, region | Describes 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.
| Name | Datatype | Description |
|---|---|---|
aws_account_id | string | The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe. |
refresh_id | string | The ID of the refresh, which is performed when the topic is created or updated. |
region | string | AWS region (default: us-east-1) |
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. |
SELECT examples
- describe_topic_refresh
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
;