View a markdown version of this page

ScheduleConfiguration - Amazon CloudWatch

ScheduleConfiguration

Contains the schedule expression and time-range offsets that define when a scheduled query runs and what time range each execution covers.

Contents

ScheduleExpression

The schedule expression that defines how often the underlying CloudWatch Logs scheduled query runs. Specify a rate() expression, for example rate(5 minutes).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

EndTimeOffset

The offset, in seconds, before the scheduled execution time at which the query time range ends. Must be non-negative and less than StartTimeOffset. The default is 0.

Type: Long

Required: No

StartTimeOffset

The offset, in seconds, before the scheduled execution time at which the query time range begins. For example, an offset of 360 (6 minutes) on a query running at 12:05:00 starts the query time range at 11:59:00.

Type: Long

Required: No

See Also

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