Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.EC2.DescribeInstanceEventWindows
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.
This operation returns paginated results.
Synopsis
- data DescribeInstanceEventWindows = DescribeInstanceEventWindows' {}
- newDescribeInstanceEventWindows :: DescribeInstanceEventWindows
- describeInstanceEventWindows_dryRun :: Lens' DescribeInstanceEventWindows (Maybe Bool)
- describeInstanceEventWindows_filters :: Lens' DescribeInstanceEventWindows (Maybe [Filter])
- describeInstanceEventWindows_instanceEventWindowIds :: Lens' DescribeInstanceEventWindows (Maybe [Text])
- describeInstanceEventWindows_maxResults :: Lens' DescribeInstanceEventWindows (Maybe Natural)
- describeInstanceEventWindows_nextToken :: Lens' DescribeInstanceEventWindows (Maybe Text)
- data DescribeInstanceEventWindowsResponse = DescribeInstanceEventWindowsResponse' {}
- newDescribeInstanceEventWindowsResponse :: Int -> DescribeInstanceEventWindowsResponse
- describeInstanceEventWindowsResponse_instanceEventWindows :: Lens' DescribeInstanceEventWindowsResponse (Maybe [InstanceEventWindow])
- describeInstanceEventWindowsResponse_nextToken :: Lens' DescribeInstanceEventWindowsResponse (Maybe Text)
- describeInstanceEventWindowsResponse_httpStatus :: Lens' DescribeInstanceEventWindowsResponse Int
Creating a Request
data DescribeInstanceEventWindows Source #
Describe instance event windows by InstanceEventWindow.
See: newDescribeInstanceEventWindows
smart constructor.
Constructors
DescribeInstanceEventWindows' | |
Fields
|
Instances
newDescribeInstanceEventWindows :: DescribeInstanceEventWindows Source #
Create a value of DescribeInstanceEventWindows
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DescribeInstanceEventWindows'
, describeInstanceEventWindows_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
.
$sel:filters:DescribeInstanceEventWindows'
, describeInstanceEventWindows_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 keyOwner
and the valueCMX
, specifytag:Owner
for the filter name andCMX
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.
$sel:instanceEventWindowIds:DescribeInstanceEventWindows'
, describeInstanceEventWindows_instanceEventWindowIds
- The IDs of the event windows.
$sel:maxResults:DescribeInstanceEventWindows'
, describeInstanceEventWindows_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.
DescribeInstanceEventWindows
, describeInstanceEventWindows_nextToken
- The token to request the next page of results.
Request Lenses
describeInstanceEventWindows_dryRun :: Lens' DescribeInstanceEventWindows (Maybe Bool) Source #
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
.
describeInstanceEventWindows_filters :: Lens' DescribeInstanceEventWindows (Maybe [Filter]) Source #
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 keyOwner
and the valueCMX
, specifytag:Owner
for the filter name andCMX
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.
describeInstanceEventWindows_instanceEventWindowIds :: Lens' DescribeInstanceEventWindows (Maybe [Text]) Source #
The IDs of the event windows.
describeInstanceEventWindows_maxResults :: Lens' DescribeInstanceEventWindows (Maybe Natural) Source #
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.
describeInstanceEventWindows_nextToken :: Lens' DescribeInstanceEventWindows (Maybe Text) Source #
The token to request the next page of results.
Destructuring the Response
data DescribeInstanceEventWindowsResponse Source #
See: newDescribeInstanceEventWindowsResponse
smart constructor.
Constructors
DescribeInstanceEventWindowsResponse' | |
Fields
|
Instances
newDescribeInstanceEventWindowsResponse Source #
Arguments
:: Int | |
-> DescribeInstanceEventWindowsResponse |
Create a value of DescribeInstanceEventWindowsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceEventWindows:DescribeInstanceEventWindowsResponse'
, describeInstanceEventWindowsResponse_instanceEventWindows
- Information about the event windows.
DescribeInstanceEventWindows
, describeInstanceEventWindowsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeInstanceEventWindowsResponse'
, describeInstanceEventWindowsResponse_httpStatus
- The response's http status code.
Response Lenses
describeInstanceEventWindowsResponse_instanceEventWindows :: Lens' DescribeInstanceEventWindowsResponse (Maybe [InstanceEventWindow]) Source #
Information about the event windows.
describeInstanceEventWindowsResponse_nextToken :: Lens' DescribeInstanceEventWindowsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeInstanceEventWindowsResponse_httpStatus :: Lens' DescribeInstanceEventWindowsResponse Int Source #
The response's http status code.