data_set_refresh_properties

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

Overview

Name	data_set_refresh_properties
Type	Resource
Id	aws.quicksight.data_set_refresh_properties

Fields

The following fields are returned by SELECT queries:

describe_data_set_refresh_properties

Name	Datatype	Description
data_set_refresh_properties	object	The dataset refresh properties.
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_data_set_refresh_properties	select	aws_account_id, data_set_id, region		Describes the refresh properties of a dataset.
put_data_set_refresh_properties	replace	aws_account_id, data_set_id, region, DataSetRefreshProperties		Creates or updates the dataset refresh properties for the dataset.
delete_data_set_refresh_properties	delete	aws_account_id, data_set_id, region		Deletes the dataset refresh properties of the dataset.

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 Amazon Web Services account ID.
data_set_id	string	The ID of the dataset.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_data_set_refresh_properties

Describes the refresh properties of a dataset.

SELECT
data_set_refresh_properties,
request_id,
status
FROM aws.quicksight.data_set_refresh_properties
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND data_set_id = '{{ data_set_id }}' -- required
AND region = '{{ region }}' -- required
;

REPLACE examples

put_data_set_refresh_properties

Creates or updates the dataset refresh properties for the dataset.

REPLACE aws.quicksight.data_set_refresh_properties
SET 
DataSetRefreshProperties = '{{ DataSetRefreshProperties }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND data_set_id = '{{ data_set_id }}' --required
AND region = '{{ region }}' --required
AND DataSetRefreshProperties = '{{ DataSetRefreshProperties }}' --required
RETURNING
request_id,
status;

DELETE examples

delete_data_set_refresh_properties

Deletes the dataset refresh properties of the dataset.

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