topic_refresh_schedules

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

Overview

Name	topic_refresh_schedules
Type	Resource
Id	aws.quicksight.topic_refresh_schedules

Fields

The following fields are returned by SELECT queries:

describe_topic_refresh_schedule

Name	Datatype	Description
dataset_arn	string	The Amazon Resource Name (ARN) of the dataset.
refresh_schedule	object	A structure that represents a topic refresh schedule.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
topic_arn	string	The Amazon Resource Name (ARN) of the topic.
topic_id	string	The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>^[A-Za-z0-9-_.\+]*$</code>)

list_topic_refresh_schedules

Name	Datatype	Description
refresh_schedules	array	The list of topic refresh schedules.
request_id	string	The Amazon Web Services request ID for this operation.
status	integer	The HTTP status of the request.
topic_arn	string	The Amazon Resource Name (ARN) of the topic.
topic_id	string	The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. (pattern: <code>^[A-Za-z0-9-_.\+]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_topic_refresh_schedule	select	aws_account_id, topic_id, dataset_id, region		Deletes a topic refresh schedule.
list_topic_refresh_schedules	select	aws_account_id, topic_id, region		Lists all of the refresh schedules for a topic.
create_topic_refresh_schedule	insert	aws_account_id, topic_id, region, DatasetArn, RefreshSchedule		Creates a topic refresh schedule.
update_topic_refresh_schedule	update	aws_account_id, topic_id, dataset_id, region, RefreshSchedule		Updates a topic refresh schedule.
delete_topic_refresh_schedule	delete	aws_account_id, topic_id, dataset_id, region		Deletes a topic refresh schedule.

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.
dataset_id	string	The ID of the dataset.
region	string	AWS region (default: us-east-1)
topic_id	string	The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

SELECT examples

describe_topic_refresh_schedule

Deletes a topic refresh schedule.

SELECT
dataset_arn,
refresh_schedule,
request_id,
status,
topic_arn,
topic_id
FROM aws.quicksight.topic_refresh_schedules
WHERE aws_account_id = '{{ aws_account_id }}' -- required
AND topic_id = '{{ topic_id }}' -- required
AND dataset_id = '{{ dataset_id }}' -- required
AND region = '{{ region }}' -- required
;

list_topic_refresh_schedules

Lists all of the refresh schedules for a topic.

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

INSERT examples

create_topic_refresh_schedule

Creates a topic refresh schedule.

INSERT INTO aws.quicksight.topic_refresh_schedules (
DatasetArn,
DatasetName,
RefreshSchedule,
aws_account_id,
topic_id,
region
)
SELECT 
'{{ DatasetArn }}' /* required */,
'{{ DatasetName }}',
'{{ RefreshSchedule }}' /* required */,
'{{ aws_account_id }}',
'{{ topic_id }}',
'{{ region }}'
RETURNING
dataset_arn,
request_id,
status,
topic_arn,
topic_id
;

Manifest

# Description fields are for documentation purposes
- name: topic_refresh_schedules
props:
  - name: aws_account_id
    value: "{{ aws_account_id }}"
    description: Required parameter for the topic_refresh_schedules resource.
  - name: topic_id
    value: "{{ topic_id }}"
    description: Required parameter for the topic_refresh_schedules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the topic_refresh_schedules resource.
  - name: DatasetArn
    value: "{{ DatasetArn }}"
  - name: DatasetName
    value: "{{ DatasetName }}"
  - name: RefreshSchedule
    description: |
      A structure that represents a topic refresh schedule.
    value:
      IsEnabled: {{ IsEnabled }}
      BasedOnSpiceSchedule: {{ BasedOnSpiceSchedule }}
      StartingAt: "{{ StartingAt }}"
      Timezone: "{{ Timezone }}"
      RepeatAt: "{{ RepeatAt }}"
      TopicScheduleType: "{{ TopicScheduleType }}"

UPDATE examples

update_topic_refresh_schedule

Updates a topic refresh schedule.

UPDATE aws.quicksight.topic_refresh_schedules
SET 
RefreshSchedule = '{{ RefreshSchedule }}'
WHERE 
aws_account_id = '{{ aws_account_id }}' --required
AND topic_id = '{{ topic_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND region = '{{ region }}' --required
AND RefreshSchedule = '{{ RefreshSchedule }}' --required
RETURNING
dataset_arn,
request_id,
status,
topic_arn,
topic_id;

DELETE examples

delete_topic_refresh_schedule

Deletes a topic refresh schedule.

DELETE FROM aws.quicksight.topic_refresh_schedules
WHERE aws_account_id = '{{ aws_account_id }}' --required
AND topic_id = '{{ topic_id }}' --required
AND dataset_id = '{{ dataset_id }}' --required
AND region = '{{ region }}' --required
;