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 |
Describes the specified Scheduled Instances or all your Scheduled Instances.
This operation returns paginated results.
Synopsis
- data DescribeScheduledInstances = DescribeScheduledInstances' {}
- newDescribeScheduledInstances :: DescribeScheduledInstances
- describeScheduledInstances_dryRun :: Lens' DescribeScheduledInstances (Maybe Bool)
- describeScheduledInstances_filters :: Lens' DescribeScheduledInstances (Maybe [Filter])
- describeScheduledInstances_maxResults :: Lens' DescribeScheduledInstances (Maybe Int)
- describeScheduledInstances_nextToken :: Lens' DescribeScheduledInstances (Maybe Text)
- describeScheduledInstances_scheduledInstanceIds :: Lens' DescribeScheduledInstances (Maybe [Text])
- describeScheduledInstances_slotStartTimeRange :: Lens' DescribeScheduledInstances (Maybe SlotStartTimeRangeRequest)
- data DescribeScheduledInstancesResponse = DescribeScheduledInstancesResponse' {}
- newDescribeScheduledInstancesResponse :: Int -> DescribeScheduledInstancesResponse
- describeScheduledInstancesResponse_nextToken :: Lens' DescribeScheduledInstancesResponse (Maybe Text)
- describeScheduledInstancesResponse_scheduledInstanceSet :: Lens' DescribeScheduledInstancesResponse (Maybe [ScheduledInstance])
- describeScheduledInstancesResponse_httpStatus :: Lens' DescribeScheduledInstancesResponse Int
Creating a Request
data DescribeScheduledInstances Source #
Contains the parameters for DescribeScheduledInstances.
See: newDescribeScheduledInstances
smart constructor.
DescribeScheduledInstances' | |
|
Instances
newDescribeScheduledInstances :: DescribeScheduledInstances Source #
Create a value of DescribeScheduledInstances
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:DescribeScheduledInstances'
, describeScheduledInstances_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:DescribeScheduledInstances'
, describeScheduledInstances_filters
- The filters.
availability-zone
- The Availability Zone (for example,us-west-2a
).instance-type
- The instance type (for example,c4.large
).network-platform
- The network platform (EC2-Classic
orEC2-VPC
).platform
- The platform (Linux/UNIX
orWindows
).
$sel:maxResults:DescribeScheduledInstances'
, describeScheduledInstances_maxResults
- The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 100. To retrieve the
remaining results, make another call with the returned NextToken
value.
DescribeScheduledInstances
, describeScheduledInstances_nextToken
- The token for the next set of results.
$sel:scheduledInstanceIds:DescribeScheduledInstances'
, describeScheduledInstances_scheduledInstanceIds
- The Scheduled Instance IDs.
$sel:slotStartTimeRange:DescribeScheduledInstances'
, describeScheduledInstances_slotStartTimeRange
- The time period for the first schedule to start.
Request Lenses
describeScheduledInstances_dryRun :: Lens' DescribeScheduledInstances (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
.
describeScheduledInstances_filters :: Lens' DescribeScheduledInstances (Maybe [Filter]) Source #
The filters.
availability-zone
- The Availability Zone (for example,us-west-2a
).instance-type
- The instance type (for example,c4.large
).network-platform
- The network platform (EC2-Classic
orEC2-VPC
).platform
- The platform (Linux/UNIX
orWindows
).
describeScheduledInstances_maxResults :: Lens' DescribeScheduledInstances (Maybe Int) Source #
The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 100. To retrieve the
remaining results, make another call with the returned NextToken
value.
describeScheduledInstances_nextToken :: Lens' DescribeScheduledInstances (Maybe Text) Source #
The token for the next set of results.
describeScheduledInstances_scheduledInstanceIds :: Lens' DescribeScheduledInstances (Maybe [Text]) Source #
The Scheduled Instance IDs.
describeScheduledInstances_slotStartTimeRange :: Lens' DescribeScheduledInstances (Maybe SlotStartTimeRangeRequest) Source #
The time period for the first schedule to start.
Destructuring the Response
data DescribeScheduledInstancesResponse Source #
Contains the output of DescribeScheduledInstances.
See: newDescribeScheduledInstancesResponse
smart constructor.
DescribeScheduledInstancesResponse' | |
|
Instances
newDescribeScheduledInstancesResponse Source #
Create a value of DescribeScheduledInstancesResponse
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:
DescribeScheduledInstances
, describeScheduledInstancesResponse_nextToken
- The token required to retrieve the next set of results. This value is
null
when there are no more results to return.
$sel:scheduledInstanceSet:DescribeScheduledInstancesResponse'
, describeScheduledInstancesResponse_scheduledInstanceSet
- Information about the Scheduled Instances.
$sel:httpStatus:DescribeScheduledInstancesResponse'
, describeScheduledInstancesResponse_httpStatus
- The response's http status code.
Response Lenses
describeScheduledInstancesResponse_nextToken :: Lens' DescribeScheduledInstancesResponse (Maybe Text) Source #
The token required to retrieve the next set of results. This value is
null
when there are no more results to return.
describeScheduledInstancesResponse_scheduledInstanceSet :: Lens' DescribeScheduledInstancesResponse (Maybe [ScheduledInstance]) Source #
Information about the Scheduled Instances.
describeScheduledInstancesResponse_httpStatus :: Lens' DescribeScheduledInstancesResponse Int Source #
The response's http status code.