TopicRefreshSchedule - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

TopicRefreshSchedule

A structure that represents a topic refresh schedule.

Contents

Note

In the following list, the required parameters are described first.

BasedOnSpiceSchedule

A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

Type: Boolean

Required: Yes

IsEnabled

A Boolean value that controls whether to schedule is enabled.

Type: Boolean

Required: Yes

RepeatAt

The time of day when the refresh should run, for example, Monday-Sunday.

Type: String

Length Constraints: Maximum length of 256.

Required: No

StartingAt

The starting date and time for the refresh schedule.

Type: Timestamp

Required: No

Timezone

The timezone that you want the refresh schedule to use.

Type: String

Length Constraints: Maximum length of 256.

Required: No

TopicScheduleType

The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

Type: String

Valid Values: HOURLY | DAILY | WEEKLY | MONTHLY

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: