refresh_schedules

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

Overview

Name	refresh_schedules
Type	Resource
Id	aws.quicksight.refresh_schedules

Fields

The following fields are returned by SELECT queries:

describe_refresh_schedule

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the refresh schedule.
refresh_schedule	object	The refresh schedule of a dataset.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.

list_refresh_schedules

Name	Datatype	Description
refresh_schedules	array	The list of refresh schedules for the dataset.
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_refresh_schedule	select	aws_account_id, data_set_id, schedule_id, region		Provides a summary of a refresh schedule.
list_refresh_schedules	select	aws_account_id, data_set_id, region		Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
create_refresh_schedule	insert	data_set_id, aws_account_id, region, Schedule		Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
update_refresh_schedule	update	data_set_id, aws_account_id, region, Schedule		Updates a refresh schedule for a dataset.
delete_refresh_schedule	delete	data_set_id, aws_account_id, schedule_id, region		Deletes a refresh schedule from a 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)
schedule_id	string	The ID of the refresh schedule.

SELECT examples

describe_refresh_schedule

Provides a summary of a refresh schedule.

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

list_refresh_schedules

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

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

INSERT examples

create_refresh_schedule

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

INSERT INTO aws.quicksight.refresh_schedules (
Schedule,
data_set_id,
aws_account_id,
region
)
SELECT 
'{{ Schedule }}' /* required */,
'{{ data_set_id }}',
'{{ aws_account_id }}',
'{{ region }}'
RETURNING
arn,
request_id,
schedule_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: refresh_schedules
props:
  - name: data_set_id
    value: "{{ data_set_id }}"
    description: Required parameter for the refresh_schedules resource.
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the refresh_schedules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the refresh_schedules resource.
  - name: Schedule
    description: |
      The refresh schedule of a dataset.
    value:
      ScheduleId: "{{ ScheduleId }}"
      ScheduleFrequency:
        Interval: "{{ Interval }}"
        RefreshOnDay:
          DayOfWeek: "{{ DayOfWeek }}"
          DayOfMonth: "{{ DayOfMonth }}"
        Timezone: "{{ Timezone }}"
        TimeOfTheDay: "{{ TimeOfTheDay }}"
      StartAfterDateTime: "{{ StartAfterDateTime }}"
      RefreshType: "{{ RefreshType }}"
      Arn: "{{ Arn }}"

UPDATE examples

update_refresh_schedule

Updates a refresh schedule for a dataset.

UPDATE aws.quicksight.refresh_schedules
SET 
Schedule = '{{ Schedule }}'
WHERE 
data_set_id = '{{ data_set_id }}' --required
AND aws_account_id = '{{ aws_account_id }}' --required
AND region = '{{ region }}' --required
AND Schedule = '{{ Schedule }}' --required
RETURNING
arn,
request_id,
schedule_id,
status;

DELETE examples

delete_refresh_schedule

Deletes a refresh schedule from a dataset.

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