describe_instance_event_windows¶
Operation¶
async
¶
describe_instance_event_windows(input: DescribeInstanceEventWindowsInput, plugins: list[Plugin] | None = None) -> DescribeInstanceEventWindowsOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DescribeInstanceEventWindowsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeInstanceEventWindowsOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Describe instance event windows by InstanceEventWindow.
Attributes¶
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
filters: list[Filter] | None = ...
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 keyOwnerand the valueCMX, specifytag:Ownerfor the filter name andCMXfor 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.
class-attribute
instance-attribute
¶
The IDs of the event windows.
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeInstanceEventWindowsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
instance_event_windows: list[InstanceEventWindow] | None = ...
Information about the event windows.
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.