ScheduleConfig
Defines the schedule for a scheduled report, including the cron expression, time zone, active period, and the schedule state.
Contents
- scheduleExpression
-
The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces:
cron(minutes hours day_of_month month day_of_week year).Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*Required: No
- scheduleExpressionTimeZone
-
The time zone for the schedule expression, for example,
UTC.Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*Required: No
- schedulePeriod
-
The time period during which the schedule is active.
Type: SchedulePeriod object
Required: No
- state
-
The state of the schedule.
ENABLEDmeans the scheduled report runs according to its schedule expression.DISABLEDmeans the scheduled report is paused and will not run until re-enabled.Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: