GET

/#Action=CreateInstanceEventWindow

http://ec2.{region}.amazonaws.com/#Action=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 Amazon Web Services 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 <a>AssociateInstanceEventWindow</a> API. <important> Event windows are applicable only for scheduled events that stop, reboot, or terminate instances. Event windows are not applicable for: <ul> <li> Expedited scheduled events and network maintenance events. </li> <li> Unscheduled maintenance such as AutoRecovery and unplanned reboots. </li> </ul> </important> For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html">Define event windows for scheduled events</a> in the Amazon EC2 User Guide.

Access Token Required: API Key

Query Params

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Namestring

The name of the event window.

TimeRangearray

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

CronExpressionstring

The cron expression for the event window, for example, <code>* 0-4,20-23 * * 1,5</code>. If you specify a cron expression, you can't specify a time range. Constraints: <ul> <li> Only hour and day of the week values are supported. </li> <li> For day of the week values, you can specify either integers <code>0</code> through <code>6</code>, or alternative single values <code>SUN</code> through <code>SAT</code>. </li> <li> The minute, month, and year must be specified by <code>*</code>. </li> <li> The hour value must be one or a multiple range, for example, <code>0-4</code> or <code>0-4,20-23</code>. </li> <li> Each hour range must be >= 2 hours, for example, <code>0-2</code> or <code>20-23</code>. </li> <li> The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours. </li> </ul> For more information about cron expressions, see <a href="https://en.wikipedia.org/wiki/Cron">cron</a> on the Wikipedia website.

TagSpecificationarray

The tags to apply to the event window.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=CreateInstanceEventWindow' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}