Describe Instance Event Windows

ec2_describe_instance_event_windows

R Documentation

Describes the specified event windows or all 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.

Usage

ec2_describe_instance_event_windows(DryRun, InstanceEventWindowIds,
  Filters, MaxResults, NextToken)

Arguments

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.

InstanceEventWindowIds

The IDs of the event windows.

Filters

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:<key>⁠ - 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.

MaxResults

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

The token to request the next page of results.

Value

A list with the following syntax:

list(
  InstanceEventWindows = list(
    list(
      InstanceEventWindowId = "string",
      TimeRanges = list(
        list(
          StartWeekDay = "sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday",
          StartHour = 123,
          EndWeekDay = "sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday",
          EndHour = 123
        )
      ),
      Name = "string",
      CronExpression = "string",
      AssociationTarget = list(
        InstanceIds = list(
          "string"
        ),
        Tags = list(
          list(
            Key = "string",
            Value = "string"
          )
        ),
        DedicatedHostIds = list(
          "string"
        )
      ),
      State = "creating"|"deleting"|"active"|"deleted",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_instance_event_windows(
  DryRun = TRUE|FALSE,
  InstanceEventWindowIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)