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.DescribeScheduledInstanceAvailability

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeScheduledInstanceAvailability Source #

Contains the parameters for DescribeScheduledInstanceAvailability.

See: newDescribeScheduledInstanceAvailability smart constructor.

Constructors

DescribeScheduledInstanceAvailability'

Fields

dryRun :: Maybe Bool
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.
filters :: Maybe [Filter]
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 or EC2-VPC).
- platform - The platform (Linux/UNIX or Windows).
maxResults :: Maybe Natural
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.
maxSlotDurationInHours :: Maybe Int
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.
minSlotDurationInHours :: Maybe Int
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.
nextToken :: Maybe Text
The token for the next set of results.
firstSlotStartTimeRange :: SlotDateTimeRangeRequest
The time period for the first schedule to start.
recurrence :: ScheduledInstanceRecurrenceRequest
The schedule recurrence.

Instances

Instances details

ToHeaders DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods toHeaders :: DescribeScheduledInstanceAvailability -> [Header] #
ToPath DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods toPath :: DescribeScheduledInstanceAvailability -> ByteString #
ToQuery DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods toQuery :: DescribeScheduledInstanceAvailability -> QueryString #
AWSPager DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods page :: DescribeScheduledInstanceAvailability -> AWSResponse DescribeScheduledInstanceAvailability -> Maybe DescribeScheduledInstanceAvailability #
AWSRequest DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Associated Types type AWSResponse DescribeScheduledInstanceAvailability # Methods request :: (Service -> Service) -> DescribeScheduledInstanceAvailability -> Request DescribeScheduledInstanceAvailability # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeScheduledInstanceAvailability -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeScheduledInstanceAvailability))) #
Generic DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Associated Types type Rep DescribeScheduledInstanceAvailability :: Type -> Type # Methods from :: DescribeScheduledInstanceAvailability -> Rep DescribeScheduledInstanceAvailability x # to :: Rep DescribeScheduledInstanceAvailability x -> DescribeScheduledInstanceAvailability #
Read DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods readsPrec :: Int -> ReadS DescribeScheduledInstanceAvailability # readList :: ReadS [DescribeScheduledInstanceAvailability] # readPrec :: ReadPrec DescribeScheduledInstanceAvailability # readListPrec :: ReadPrec [DescribeScheduledInstanceAvailability] #
Show DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods showsPrec :: Int -> DescribeScheduledInstanceAvailability -> ShowS # show :: DescribeScheduledInstanceAvailability -> String # showList :: [DescribeScheduledInstanceAvailability] -> ShowS #
NFData DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods rnf :: DescribeScheduledInstanceAvailability -> () #
Eq DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods (==) :: DescribeScheduledInstanceAvailability -> DescribeScheduledInstanceAvailability -> Bool # (/=) :: DescribeScheduledInstanceAvailability -> DescribeScheduledInstanceAvailability -> Bool #
Hashable DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods hashWithSalt :: Int -> DescribeScheduledInstanceAvailability -> Int # hash :: DescribeScheduledInstanceAvailability -> Int #
type AWSResponse DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability type AWSResponse DescribeScheduledInstanceAvailability = DescribeScheduledInstanceAvailabilityResponse
type Rep DescribeScheduledInstanceAvailability Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability type Rep DescribeScheduledInstanceAvailability = D1 ('MetaData "DescribeScheduledInstanceAvailability" "Amazonka.EC2.DescribeScheduledInstanceAvailability" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeScheduledInstanceAvailability'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "maxSlotDurationInHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "minSlotDurationInHours") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "firstSlotStartTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SlotDateTimeRangeRequest) :*: S1 ('MetaSel ('Just "recurrence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduledInstanceRecurrenceRequest)))))

newDescribeScheduledInstanceAvailability Source #

Arguments

:: SlotDateTimeRangeRequest	`$sel:firstSlotStartTimeRange:DescribeScheduledInstanceAvailability'`
-> ScheduledInstanceRecurrenceRequest	`DescribeScheduledInstanceAvailability`
-> 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 or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).

$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 or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).

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.

Constructors

DescribeScheduledInstanceAvailabilityResponse'
Fields nextToken :: Maybe Text The token required to retrieve the next set of results. This value is `null` when there are no more results to return. scheduledInstanceAvailabilitySet :: Maybe [ScheduledInstanceAvailability] Information about the available Scheduled Instances. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeScheduledInstanceAvailabilityResponse Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Associated Types type Rep DescribeScheduledInstanceAvailabilityResponse :: Type -> Type # Methods from :: DescribeScheduledInstanceAvailabilityResponse -> Rep DescribeScheduledInstanceAvailabilityResponse x # to :: Rep DescribeScheduledInstanceAvailabilityResponse x -> DescribeScheduledInstanceAvailabilityResponse #
Read DescribeScheduledInstanceAvailabilityResponse Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods readsPrec :: Int -> ReadS DescribeScheduledInstanceAvailabilityResponse # readList :: ReadS [DescribeScheduledInstanceAvailabilityResponse] # readPrec :: ReadPrec DescribeScheduledInstanceAvailabilityResponse # readListPrec :: ReadPrec [DescribeScheduledInstanceAvailabilityResponse] #
Show DescribeScheduledInstanceAvailabilityResponse Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods showsPrec :: Int -> DescribeScheduledInstanceAvailabilityResponse -> ShowS # show :: DescribeScheduledInstanceAvailabilityResponse -> String # showList :: [DescribeScheduledInstanceAvailabilityResponse] -> ShowS #
NFData DescribeScheduledInstanceAvailabilityResponse Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods rnf :: DescribeScheduledInstanceAvailabilityResponse -> () #
Eq DescribeScheduledInstanceAvailabilityResponse Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability Methods (==) :: DescribeScheduledInstanceAvailabilityResponse -> DescribeScheduledInstanceAvailabilityResponse -> Bool # (/=) :: DescribeScheduledInstanceAvailabilityResponse -> DescribeScheduledInstanceAvailabilityResponse -> Bool #
type Rep DescribeScheduledInstanceAvailabilityResponse Source #
Instance details Defined in Amazonka.EC2.DescribeScheduledInstanceAvailability type Rep DescribeScheduledInstanceAvailabilityResponse = D1 ('MetaData "DescribeScheduledInstanceAvailabilityResponse" "Amazonka.EC2.DescribeScheduledInstanceAvailability" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeScheduledInstanceAvailabilityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "scheduledInstanceAvailabilitySet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledInstanceAvailability])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeScheduledInstanceAvailabilityResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeScheduledInstanceAvailabilityResponse'`
-> 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.