Request Parameters Response Elements Errors See Also

CreateInstanceEventWindow

Creates an event window in which scheduled events for the associated Amazon EC2 instances can run.

You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC.

You can create up to 200 event windows per AWS Region.

When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the AssociateInstanceEventWindow API.

Important

Event windows are applicable only for scheduled events that stop, reboot, or terminate instances.

Event windows are not applicable for:

Expedited scheduled events and network maintenance events.
Unscheduled maintenance such as AutoRecovery and unplanned reboots.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

CronExpression

The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If you specify a cron expression, you can't specify a time range.

Constraints:

Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

Name

The name of the event window.

Type: String

Required: No

TagSpecification.N

The tags to apply to the event window.

Type: Array of TagSpecification objects

Required: No

TimeRange.N

The time range for the event window. If you specify a time range, you can't specify a cron expression.

Type: Array of InstanceEventWindowTimeRangeRequest objects

Required: No

Response Elements

The following elements are returned by the service.

instanceEventWindow

Information about the event window.

Type: InstanceEventWindow object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.