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 |
Finds available schedules that meet the specified criteria.
You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.
This operation returns paginated results.
Synopsis
- data DescribeScheduledInstanceAvailability = DescribeScheduledInstanceAvailability' {}
- newDescribeScheduledInstanceAvailability :: SlotDateTimeRangeRequest -> ScheduledInstanceRecurrenceRequest -> DescribeScheduledInstanceAvailability
- describeScheduledInstanceAvailability_dryRun :: Lens' DescribeScheduledInstanceAvailability (Maybe Bool)
- describeScheduledInstanceAvailability_filters :: Lens' DescribeScheduledInstanceAvailability (Maybe [Filter])
- describeScheduledInstanceAvailability_maxResults :: Lens' DescribeScheduledInstanceAvailability (Maybe Natural)
- describeScheduledInstanceAvailability_maxSlotDurationInHours :: Lens' DescribeScheduledInstanceAvailability (Maybe Int)
- describeScheduledInstanceAvailability_minSlotDurationInHours :: Lens' DescribeScheduledInstanceAvailability (Maybe Int)
- describeScheduledInstanceAvailability_nextToken :: Lens' DescribeScheduledInstanceAvailability (Maybe Text)
- describeScheduledInstanceAvailability_firstSlotStartTimeRange :: Lens' DescribeScheduledInstanceAvailability SlotDateTimeRangeRequest
- describeScheduledInstanceAvailability_recurrence :: Lens' DescribeScheduledInstanceAvailability ScheduledInstanceRecurrenceRequest
- data DescribeScheduledInstanceAvailabilityResponse = DescribeScheduledInstanceAvailabilityResponse' {}
- newDescribeScheduledInstanceAvailabilityResponse :: Int -> DescribeScheduledInstanceAvailabilityResponse
- describeScheduledInstanceAvailabilityResponse_nextToken :: Lens' DescribeScheduledInstanceAvailabilityResponse (Maybe Text)
- describeScheduledInstanceAvailabilityResponse_scheduledInstanceAvailabilitySet :: Lens' DescribeScheduledInstanceAvailabilityResponse (Maybe [ScheduledInstanceAvailability])
- describeScheduledInstanceAvailabilityResponse_httpStatus :: Lens' DescribeScheduledInstanceAvailabilityResponse Int
Creating a Request
data DescribeScheduledInstanceAvailability Source #
Contains the parameters for DescribeScheduledInstanceAvailability.
See: newDescribeScheduledInstanceAvailability
smart constructor.
DescribeScheduledInstanceAvailability' | |
|
Instances
newDescribeScheduledInstanceAvailability Source #
:: SlotDateTimeRangeRequest |
|
-> ScheduledInstanceRecurrenceRequest | |
-> DescribeScheduledInstanceAvailability |
Create a value of DescribeScheduledInstanceAvailability
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:DescribeScheduledInstanceAvailability'
, describeScheduledInstanceAvailability_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:DescribeScheduledInstanceAvailability'
, describeScheduledInstanceAvailability_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:DescribeScheduledInstanceAvailability'
, describeScheduledInstanceAvailability_maxResults
- The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 300. To retrieve the
remaining results, make another call with the returned NextToken
value.
$sel:maxSlotDurationInHours:DescribeScheduledInstanceAvailability'
, describeScheduledInstanceAvailability_maxSlotDurationInHours
- The maximum available duration, in hours. This value must be greater
than MinSlotDurationInHours
and less than 1,720.
$sel:minSlotDurationInHours:DescribeScheduledInstanceAvailability'
, describeScheduledInstanceAvailability_minSlotDurationInHours
- The minimum available duration, in hours. The minimum required duration
is 1,200 hours per year. For example, the minimum daily schedule is 4
hours, the minimum weekly schedule is 24 hours, and the minimum monthly
schedule is 100 hours.
DescribeScheduledInstanceAvailability
, describeScheduledInstanceAvailability_nextToken
- The token for the next set of results.
$sel:firstSlotStartTimeRange:DescribeScheduledInstanceAvailability'
, describeScheduledInstanceAvailability_firstSlotStartTimeRange
- The time period for the first schedule to start.
DescribeScheduledInstanceAvailability
, describeScheduledInstanceAvailability_recurrence
- The schedule recurrence.
Request Lenses
describeScheduledInstanceAvailability_dryRun :: Lens' DescribeScheduledInstanceAvailability (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
.
describeScheduledInstanceAvailability_filters :: Lens' DescribeScheduledInstanceAvailability (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
).
describeScheduledInstanceAvailability_maxResults :: Lens' DescribeScheduledInstanceAvailability (Maybe Natural) Source #
The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 300. To retrieve the
remaining results, make another call with the returned NextToken
value.
describeScheduledInstanceAvailability_maxSlotDurationInHours :: Lens' DescribeScheduledInstanceAvailability (Maybe Int) Source #
The maximum available duration, in hours. This value must be greater
than MinSlotDurationInHours
and less than 1,720.
describeScheduledInstanceAvailability_minSlotDurationInHours :: Lens' DescribeScheduledInstanceAvailability (Maybe Int) Source #
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
describeScheduledInstanceAvailability_nextToken :: Lens' DescribeScheduledInstanceAvailability (Maybe Text) Source #
The token for the next set of results.
describeScheduledInstanceAvailability_firstSlotStartTimeRange :: Lens' DescribeScheduledInstanceAvailability SlotDateTimeRangeRequest Source #
The time period for the first schedule to start.
describeScheduledInstanceAvailability_recurrence :: Lens' DescribeScheduledInstanceAvailability ScheduledInstanceRecurrenceRequest Source #
The schedule recurrence.
Destructuring the Response
data DescribeScheduledInstanceAvailabilityResponse Source #
Contains the output of DescribeScheduledInstanceAvailability.
See: newDescribeScheduledInstanceAvailabilityResponse
smart constructor.
DescribeScheduledInstanceAvailabilityResponse' | |
|
Instances
newDescribeScheduledInstanceAvailabilityResponse Source #
:: Int |
|
-> DescribeScheduledInstanceAvailabilityResponse |
Create a value of DescribeScheduledInstanceAvailabilityResponse
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:
DescribeScheduledInstanceAvailability
, describeScheduledInstanceAvailabilityResponse_nextToken
- The token required to retrieve the next set of results. This value is
null
when there are no more results to return.
$sel:scheduledInstanceAvailabilitySet:DescribeScheduledInstanceAvailabilityResponse'
, describeScheduledInstanceAvailabilityResponse_scheduledInstanceAvailabilitySet
- Information about the available Scheduled Instances.
$sel:httpStatus:DescribeScheduledInstanceAvailabilityResponse'
, describeScheduledInstanceAvailabilityResponse_httpStatus
- The response's http status code.
Response Lenses
describeScheduledInstanceAvailabilityResponse_nextToken :: Lens' DescribeScheduledInstanceAvailabilityResponse (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.
describeScheduledInstanceAvailabilityResponse_scheduledInstanceAvailabilitySet :: Lens' DescribeScheduledInstanceAvailabilityResponse (Maybe [ScheduledInstanceAvailability]) Source #
Information about the available Scheduled Instances.
describeScheduledInstanceAvailabilityResponse_httpStatus :: Lens' DescribeScheduledInstanceAvailabilityResponse Int Source #
The response's http status code.