refresh_schedules

Creates, updates, deletes or gets a refresh_schedule resource or lists refresh_schedules in a region

Overview

Name	refresh_schedules
Type	Resource
Description	Definition of the AWS::QuickSight::RefreshSchedule Resource Type.
Id	aws.quicksight.refresh_schedules

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the data source.
aws_account_id	string
data_set_id	string
schedule	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all refresh_schedules in a region.

SELECT
region,
arn,
aws_account_id,
data_set_id,
schedule
FROM aws.quicksight.refresh_schedules
WHERE region = 'us-east-1';

Gets all properties from an individual refresh_schedule.

SELECT
region,
arn,
aws_account_id,
data_set_id,
schedule
FROM aws.quicksight.refresh_schedules
WHERE region = 'us-east-1' AND data__Identifier = '<AwsAccountId>|<DataSetId>|<Schedule/ScheduleId>';

INSERT example

Use the following StackQL query and manifest file to create a new refresh_schedule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.quicksight.refresh_schedules (
 ,
 region
)
SELECT 
'{{  }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.quicksight.refresh_schedules (
 AwsAccountId,
 DataSetId,
 Schedule,
 region
)
SELECT 
 '{{ AwsAccountId }}',
 '{{ DataSetId }}',
 '{{ Schedule }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: refresh_schedule
    props:
      - name: AwsAccountId
        value: '{{ AwsAccountId }}'
      - name: DataSetId
        value: '{{ DataSetId }}'
      - name: Schedule
        value:
          ScheduleId: '{{ ScheduleId }}'
          ScheduleFrequency:
            Interval: '{{ Interval }}'
            RefreshOnDay:
              DayOfWeek: '{{ DayOfWeek }}'
              DayOfMonth: '{{ DayOfMonth }}'
            TimeZone: '{{ TimeZone }}'
            TimeOfTheDay: '{{ TimeOfTheDay }}'
          StartAfterDateTime: '{{ StartAfterDateTime }}'
          RefreshType: '{{ RefreshType }}'

DELETE example

/*+ delete */
DELETE FROM aws.quicksight.refresh_schedules
WHERE data__Identifier = '<AwsAccountId|DataSetId|Schedule/ScheduleId>'
AND region = 'us-east-1';

Permissions

To operate on the refresh_schedules resource, the following permissions are required:

Create

quicksight:CreateRefreshSchedule,
quicksight:DescribeRefreshSchedule

Update

quicksight:UpdateRefreshSchedule,
quicksight:DescribeRefreshSchedule

Delete

quicksight:DeleteRefreshSchedule,
quicksight:DescribeRefreshSchedule

List

quicksight:ListRefreshSchedules

Read

quicksight:DescribeRefreshSchedule