RefreshSchedule
The refresh schedule of a dataset.
Contents
Note
In the following list, the required parameters are described first.
- RefreshType
-
The type of refresh that a datset undergoes. Valid values are as follows:
-
FULL_REFRESH
: A complete refresh of a dataset. -
INCREMENTAL_REFRESH
: A partial refresh of some rows of a dataset, based on the time window specified.
For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.
Type: String
Valid Values:
INCREMENTAL_REFRESH | FULL_REFRESH
Required: Yes
-
- ScheduleFrequency
-
The frequency for the refresh schedule.
Type: RefreshFrequency object
Required: Yes
- ScheduleId
-
An identifier for the refresh schedule.
Type: String
Required: Yes
- Arn
-
The Amazon Resource Name (ARN) for the refresh schedule.
Type: String
Required: No
- StartAfterDateTime
-
Time after which the refresh schedule can be started, expressed in
YYYY-MM-DDTHH:MM:SS
format.Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: