Amazon EC2 Ec2 Instance Event Window API

The Ec2 Instance Event Window API from Amazon EC2 — 6 operation(s) for ec2 instance event window.

Business capability
IT Infrastructure Management BC-600.50

Operations 6

POST /?Action=AssociateInstanceEventWindow Associate Instance Event Window #
POST /?Action=CreateInstanceEventWindow Create Instance Event Window #
POST /?Action=DeleteInstanceEventWindow Delete Instance Event Window #
POST /?Action=DescribeInstanceEventWindows Describe Instance Event Windows #
POST /?Action=DisassociateInstanceEventWindow Disassociate Instance Event Window #
POST /?Action=ModifyInstanceEventWindow Modify Instance Event Window #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-ec2:amazon-ec2-instance-event-window-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-ec2-instance-event-window-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Instance Event Window API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Instance Event Window
paths:
  /?Action=AssociateInstanceEventWindow:
    post:
      operationId: AssociateInstanceEventWindow
      summary: Associate Instance Event Window
      description: Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AssociateInstanceEventWindowResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: AssociateInstanceEventWindow
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/AssociateInstanceEventWindowRequest'
      tags:
      - Instance Event Window
  /?Action=CreateInstanceEventWindow:
    post:
      operationId: CreateInstanceEventWindow
      summary: Create Instance Event Window
      description: '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 AssociateInstanceEventWindow API. 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.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateInstanceEventWindowResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateInstanceEventWindow
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateInstanceEventWindowRequest'
      tags:
      - Instance Event Window
  /?Action=DeleteInstanceEventWindow:
    post:
      operationId: DeleteInstanceEventWindow
      summary: Delete Instance Event Window
      description: Deletes the specified event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteInstanceEventWindowResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteInstanceEventWindow
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteInstanceEventWindowRequest'
      tags:
      - Instance Event Window
  /?Action=DescribeInstanceEventWindows:
    post:
      operationId: DescribeInstanceEventWindows
      summary: Describe Instance Event Windows
      description: Describes the specified event windows or all event windows. If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeInstanceEventWindowsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeInstanceEventWindows
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeInstanceEventWindowsRequest'
      tags:
      - Instance Event Window
  /?Action=DisassociateInstanceEventWindow:
    post:
      operationId: DisassociateInstanceEventWindow
      summary: Disassociate Instance Event Window
      description: Disassociates one or more targets from an event window. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisassociateInstanceEventWindowResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisassociateInstanceEventWindow
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DisassociateInstanceEventWindowRequest'
      tags:
      - Instance Event Window
  /?Action=ModifyInstanceEventWindow:
    post:
      operationId: ModifyInstanceEventWindow
      summary: Modify Instance Event Window
      description: Modifies the specified event window. You can define either a set of time ranges or a cron expression when modifying the event window, but not both. To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API. If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event. For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ModifyInstanceEventWindowResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyInstanceEventWindow
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyInstanceEventWindowRequest'
      tags:
      - Instance Event Window
components:
  schemas:
    InstanceEventWindowDisassociationRequest:
      type: object
      properties:
        InstanceIds:
          type: array
          items:
            type: string
          description: The IDs of the instances to disassociate from the event window.
        InstanceTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
        DedicatedHostIds:
          type: array
          items:
            type: string
          description: The IDs of the Dedicated Hosts to disassociate from the event window.
    InstanceEventWindowStateChange:
      type: object
      properties:
        InstanceEventWindowId:
          type: string
          description: The ID of the event window.
        State:
          type: string
          enum:
          - creating
          - deleting
          - active
          - deleted
          description: The current state of the event window.
    DisassociateInstanceEventWindowResult:
      type: object
      properties:
        InstanceEventWindow:
          $ref: '#/components/schemas/InstanceEventWindow'
    InstanceEventWindowTimeRange:
      type: object
      properties:
        StartWeekDay:
          type: string
          enum:
          - sunday
          - monday
          - tuesday
          - wednesday
          - thursday
          - friday
          - saturday
          description: The day on which the time range begins.
        StartHour:
          type: integer
          description: The hour when the time range begins.
        EndWeekDay:
          type: string
          enum:
          - sunday
          - monday
          - tuesday
          - wednesday
          - thursday
          - friday
          - saturday
          description: The day on which the time range ends.
        EndHour:
          type: integer
          description: The hour when the time range ends.
    DeleteInstanceEventWindowResult:
      type: object
      properties:
        InstanceEventWindowState:
          $ref: '#/components/schemas/InstanceEventWindowStateChange'
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    AssociateInstanceEventWindowResult:
      type: object
      properties:
        InstanceEventWindow:
          $ref: '#/components/schemas/InstanceEventWindow'
    AssociateInstanceEventWindowRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: 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.
        InstanceEventWindowId:
          type: string
          description: The ID of the event window.
        AssociationTarget:
          $ref: '#/components/schemas/InstanceEventWindowAssociationRequest'
      required:
      - InstanceEventWindowId
      - AssociationTarget
    DeleteInstanceEventWindowRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: 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.
        ForceDelete:
          type: boolean
          description: Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
        InstanceEventWindowId:
          type: string
          description: The ID of the event window.
      required:
      - InstanceEventWindowId
    DisassociateInstanceEventWindowRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: 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.
        InstanceEventWindowId:
          type: string
          description: The ID of the event window.
        AssociationTarget:
          $ref: '#/components/schemas/InstanceEventWindowDisassociationRequest'
      required:
      - InstanceEventWindowId
      - AssociationTarget
    InstanceEventWindow:
      type: object
      properties:
        InstanceEventWindowId:
          type: string
          description: The ID of the event window.
        TimeRanges:
          type: array
          items:
            $ref: '#/components/schemas/InstanceEventWindowTimeRange'
          description: One or more time ranges defined for the event window.
        Name:
          type: string
          description: The name of the event window.
        CronExpression:
          type: string
          description: The cron expression defined for the event window.
        AssociationTarget:
          $ref: '#/components/schemas/InstanceEventWindowAssociationTarget'
        State:
          type: string
          enum:
          - creating
          - deleting
          - active
          - deleted
          description: The current state of the event window.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The instance tags associated with the event window.
    InstanceEventWindowAssociationTarget:
      type: object
      properties:
        InstanceIds:
          type: array
          items:
            type: string
          description: The IDs of the instances associated with the event window.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can''t create tag keys beginning with aws:, you can specify existing Amazon Web Services managed tag keys (with the aws: prefix) when specifying them as targets to associate with the event window.'
        DedicatedHostIds:
          type: array
          items:
            type: string
          description: The IDs of the Dedicated Hosts associated with the event window.
    ModifyInstanceEventWindowResult:
      type: object
      properties:
        InstanceEventWindow:
          $ref: '#/components/schemas/InstanceEventWindow'
    DescribeInstanceEventWindowsResult:
      type: object
      properties:
        InstanceEventWindows:
          type: array
          items:
            $ref: '#/components/schemas/InstanceEventWindow'
          description: Information about the event windows.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    InstanceEventWindowAssociationRequest:
      type: object
      properties:
        InstanceIds:
          type: array
          items:
            type: string
          description: The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated Host ID parameter.
        InstanceTags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: 'The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window. Note that while you can''t create tag keys beginning with aws:, you can specify existing Amazon Web Services managed tag keys (with the aws: prefix) when specifying them as targets to associate with the event window.'
        DedicatedHostIds:
          type: array
          items:
            type: string
          description: The IDs of the Dedicated Hosts to associate with the event window.
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    DescribeInstanceEventWindowsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: 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.
        InstanceEventWindowIds:
          type: array
          items:
            type: string
          description: The IDs of the event windows.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'One or more filters. dedicated-host-id - The event windows associated with the specified Dedicated Host ID. event-window-name - The event windows associated with the specified names. instance-id - The event windows associated with the specified instance ID. instance-tag - The event windows associated with the specified tag and value. instance-tag-key - The event windows associated with the specified tag key, regardless of the value. instance-tag-value - The event windows associated with the specified tag value, regardless of the key. tag: - The key/value combination of a tag assigned to the ev'
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.
        NextToken:
          type: string
          description: The token to request the next page of results.
    ModifyInstanceEventWindowRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: 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.
        Name:
          type: string
          description: The name of the event window.
        InstanceEventWindowId:
          type: string
          description: The ID of the event window.
        TimeRanges:
          type: array
          items:
            $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
          description: The time ranges of the event window.
        CronExpression:
          type: string
          description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5. 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 express'
      required:
      - InstanceEventWindowId
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    CreateInstanceEventWindowRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: 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.
        Name:
          type: string
          description: The name of the event window.
        TimeRanges:
          type: array
          items:
            $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
          description: The time range for the event window. If you specify a time range, you can't specify a cron expression.
        CronExpression:
          type: string
          description: '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'
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the event window.
    CreateInstanceEventWindowResult:
      type: object
      properties:
        InstanceEventWindow:
          $ref: '#/components/schemas/InstanceEventWindow'
    InstanceEventWindowTimeRangeRequest:
      type: object
      properties:
        StartWeekDay:
          type: string
          enum:
          - sunday
          - monday
          - tuesday
          - wednesday
          - thursday
          - friday
          - saturday
          description: The day on which the time range begins.
        StartHour:
          type: integer
          description: The hour when the time range begins.
        EndWeekDay:
          type: string
          enum:
          - sunday
          - monday
          - tuesday
          - wednesday
          - thursday
          - friday
          - saturday
          description: The day on which the time range ends.
        EndHour:
          type: integer
          description: The hour when the time range ends.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)