amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeScheduledInstances

Description

Describes the specified Scheduled Instances or all your Scheduled Instances.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeScheduledInstances Source #

Contains the parameters for DescribeScheduledInstances.

See: newDescribeScheduledInstances smart constructor.

Constructors

DescribeScheduledInstances' 

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 Int

    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.

  • nextToken :: Maybe Text

    The token for the next set of results.

  • scheduledInstanceIds :: Maybe [Text]

    The Scheduled Instance IDs.

  • slotStartTimeRange :: Maybe SlotStartTimeRangeRequest

    The time period for the first schedule to start.

Instances

Instances details
ToHeaders DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

toHeaders :: DescribeScheduledInstances -> [Header] #

ToPath DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

toPath :: DescribeScheduledInstances -> ByteString #

ToQuery DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

toQuery :: DescribeScheduledInstances -> QueryString #

AWSPager DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

page :: DescribeScheduledInstances -> AWSResponse DescribeScheduledInstances -> Maybe DescribeScheduledInstances #

AWSRequest DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Associated Types

type AWSResponse DescribeScheduledInstances #

Methods

request :: (Service -> Service) -> DescribeScheduledInstances -> Request DescribeScheduledInstances #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeScheduledInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeScheduledInstances))) #

Generic DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Associated Types

type Rep DescribeScheduledInstances :: Type -> Type #

Methods

from :: DescribeScheduledInstances -> Rep DescribeScheduledInstances x #

to :: Rep DescribeScheduledInstances x -> DescribeScheduledInstances #

Read DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

readsPrec :: Int -> ReadS DescribeScheduledInstances #

readList :: ReadS [DescribeScheduledInstances] #

readPrec :: ReadPrec DescribeScheduledInstances #

readListPrec :: ReadPrec [DescribeScheduledInstances] #

Show DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

showsPrec :: Int -> DescribeScheduledInstances -> ShowS #

show :: DescribeScheduledInstances -> String #

showList :: [DescribeScheduledInstances] -> ShowS #

NFData DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

rnf :: DescribeScheduledInstances -> () #

Eq DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

(==) :: DescribeScheduledInstances -> DescribeScheduledInstances -> Bool #

(/=) :: DescribeScheduledInstances -> DescribeScheduledInstances -> Bool #

Hashable DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

hashWithSalt :: Int -> DescribeScheduledInstances -> Int #

hash :: DescribeScheduledInstances -> Int #

type AWSResponse DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

type AWSResponse DescribeScheduledInstances = DescribeScheduledInstancesResponse
type Rep DescribeScheduledInstances Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

type Rep DescribeScheduledInstances = D1 ('MetaData "DescribeScheduledInstances" "Amazonka.EC2.DescribeScheduledInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeScheduledInstances'" '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 Int)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "scheduledInstanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "slotStartTimeRange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotStartTimeRangeRequest))))))

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

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

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.

Constructors

DescribeScheduledInstancesResponse' 

Fields

Instances

Instances details
Generic DescribeScheduledInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Associated Types

type Rep DescribeScheduledInstancesResponse :: Type -> Type #

Methods

from :: DescribeScheduledInstancesResponse -> Rep DescribeScheduledInstancesResponse x #

to :: Rep DescribeScheduledInstancesResponse x -> DescribeScheduledInstancesResponse #

Read DescribeScheduledInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

readsPrec :: Int -> ReadS DescribeScheduledInstancesResponse #

readList :: ReadS [DescribeScheduledInstancesResponse] #

readPrec :: ReadPrec DescribeScheduledInstancesResponse #

readListPrec :: ReadPrec [DescribeScheduledInstancesResponse] #

Show DescribeScheduledInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

showsPrec :: Int -> DescribeScheduledInstancesResponse -> ShowS #

show :: DescribeScheduledInstancesResponse -> String #

showList :: [DescribeScheduledInstancesResponse] -> ShowS #

NFData DescribeScheduledInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

rnf :: DescribeScheduledInstancesResponse -> () #

Eq DescribeScheduledInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

Methods

(==) :: DescribeScheduledInstancesResponse -> DescribeScheduledInstancesResponse -> Bool #

(/=) :: DescribeScheduledInstancesResponse -> DescribeScheduledInstancesResponse -> Bool #

type Rep DescribeScheduledInstancesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeScheduledInstances

type Rep DescribeScheduledInstancesResponse = D1 ('MetaData "DescribeScheduledInstancesResponse" "Amazonka.EC2.DescribeScheduledInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeScheduledInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "scheduledInstanceSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledInstance])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeScheduledInstancesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeScheduledInstancesResponse'

-> DescribeScheduledInstancesResponse 

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.