Skip to content

/AWS1/CL_EC2=>DESCRIBEINSTANCEEVENTWINDOWS()

About DescribeInstanceEventWindows

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.

Method Signature

IMPORTING

Optional arguments:

IV_DRYRUN TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

IT_INSTANCEEVENTWINDOWIDS TYPE /AWS1/CL_EC2INSTEVTWINDOWIDS00=>TT_INSTANCEEVENTWINDOWIDSET TT_INSTANCEEVENTWINDOWIDSET

The IDs of the event windows.

IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

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 event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.

  • tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.

  • tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.

IV_MAXRESULTS TYPE /AWS1/EC2RESULTRANGE /AWS1/EC2RESULTRANGE

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.

IV_NEXTTOKEN TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The token to request the next page of results.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_EC2DSCINSTEVTWINDOW01 /AWS1/CL_EC2DSCINSTEVTWINDOW01