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

Description

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable performance instances in the Amazon EC2 User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeInstanceCreditSpecifications Source #

See: newDescribeInstanceCreditSpecifications smart constructor.

Constructors

DescribeInstanceCreditSpecifications' 

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.

    • instance-id - The ID of the instance.
  • instanceIds :: Maybe [Text]

    The instance IDs.

    Default: Describes all your instances.

    Constraints: Maximum 1000 explicitly specified instance IDs.

  • maxResults :: Maybe Natural

    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 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

  • nextToken :: Maybe Text

    The token to retrieve the next page of results.

Instances

Instances details
ToHeaders DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

toHeaders :: DescribeInstanceCreditSpecifications -> [Header] #

ToPath DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

toPath :: DescribeInstanceCreditSpecifications -> ByteString #

ToQuery DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

toQuery :: DescribeInstanceCreditSpecifications -> QueryString #

AWSPager DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

page :: DescribeInstanceCreditSpecifications -> AWSResponse DescribeInstanceCreditSpecifications -> Maybe DescribeInstanceCreditSpecifications #

AWSRequest DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Associated Types

type AWSResponse DescribeInstanceCreditSpecifications #

Methods

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

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

Generic DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Associated Types

type Rep DescribeInstanceCreditSpecifications :: Type -> Type #

Methods

from :: DescribeInstanceCreditSpecifications -> Rep DescribeInstanceCreditSpecifications x #

to :: Rep DescribeInstanceCreditSpecifications x -> DescribeInstanceCreditSpecifications #

Read DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

readsPrec :: Int -> ReadS DescribeInstanceCreditSpecifications #

readList :: ReadS [DescribeInstanceCreditSpecifications] #

readPrec :: ReadPrec DescribeInstanceCreditSpecifications #

readListPrec :: ReadPrec [DescribeInstanceCreditSpecifications] #

Show DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

showsPrec :: Int -> DescribeInstanceCreditSpecifications -> ShowS #

show :: DescribeInstanceCreditSpecifications -> String #

showList :: [DescribeInstanceCreditSpecifications] -> ShowS #

NFData DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

rnf :: DescribeInstanceCreditSpecifications -> () #

Eq DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

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

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

Hashable DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

hashWithSalt :: Int -> DescribeInstanceCreditSpecifications -> Int #

hash :: DescribeInstanceCreditSpecifications -> Int #

type AWSResponse DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

type AWSResponse DescribeInstanceCreditSpecifications = DescribeInstanceCreditSpecificationsResponse
type Rep DescribeInstanceCreditSpecifications Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

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

newDescribeInstanceCreditSpecifications :: DescribeInstanceCreditSpecifications Source #

Create a value of DescribeInstanceCreditSpecifications 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:DescribeInstanceCreditSpecifications', describeInstanceCreditSpecifications_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:DescribeInstanceCreditSpecifications', describeInstanceCreditSpecifications_filters - The filters.

  • instance-id - The ID of the instance.

DescribeInstanceCreditSpecifications, describeInstanceCreditSpecifications_instanceIds - The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

$sel:maxResults:DescribeInstanceCreditSpecifications', describeInstanceCreditSpecifications_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 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

DescribeInstanceCreditSpecifications, describeInstanceCreditSpecifications_nextToken - The token to retrieve the next page of results.

Request Lenses

describeInstanceCreditSpecifications_dryRun :: Lens' DescribeInstanceCreditSpecifications (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.

describeInstanceCreditSpecifications_filters :: Lens' DescribeInstanceCreditSpecifications (Maybe [Filter]) Source #

The filters.

  • instance-id - The ID of the instance.

describeInstanceCreditSpecifications_instanceIds :: Lens' DescribeInstanceCreditSpecifications (Maybe [Text]) Source #

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

describeInstanceCreditSpecifications_maxResults :: Lens' DescribeInstanceCreditSpecifications (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 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

describeInstanceCreditSpecifications_nextToken :: Lens' DescribeInstanceCreditSpecifications (Maybe Text) Source #

The token to retrieve the next page of results.

Destructuring the Response

data DescribeInstanceCreditSpecificationsResponse Source #

See: newDescribeInstanceCreditSpecificationsResponse smart constructor.

Constructors

DescribeInstanceCreditSpecificationsResponse' 

Fields

Instances

Instances details
Generic DescribeInstanceCreditSpecificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Associated Types

type Rep DescribeInstanceCreditSpecificationsResponse :: Type -> Type #

Methods

from :: DescribeInstanceCreditSpecificationsResponse -> Rep DescribeInstanceCreditSpecificationsResponse x #

to :: Rep DescribeInstanceCreditSpecificationsResponse x -> DescribeInstanceCreditSpecificationsResponse #

Read DescribeInstanceCreditSpecificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

readsPrec :: Int -> ReadS DescribeInstanceCreditSpecificationsResponse #

readList :: ReadS [DescribeInstanceCreditSpecificationsResponse] #

readPrec :: ReadPrec DescribeInstanceCreditSpecificationsResponse #

readListPrec :: ReadPrec [DescribeInstanceCreditSpecificationsResponse] #

Show DescribeInstanceCreditSpecificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

showsPrec :: Int -> DescribeInstanceCreditSpecificationsResponse -> ShowS #

show :: DescribeInstanceCreditSpecificationsResponse -> String #

showList :: [DescribeInstanceCreditSpecificationsResponse] -> ShowS #

NFData DescribeInstanceCreditSpecificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

rnf :: DescribeInstanceCreditSpecificationsResponse -> () #

Eq DescribeInstanceCreditSpecificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

Methods

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

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

type Rep DescribeInstanceCreditSpecificationsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceCreditSpecifications

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

newDescribeInstanceCreditSpecificationsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeInstanceCreditSpecificationsResponse'

-> DescribeInstanceCreditSpecificationsResponse 

Create a value of DescribeInstanceCreditSpecificationsResponse 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:instanceCreditSpecifications:DescribeInstanceCreditSpecificationsResponse', describeInstanceCreditSpecificationsResponse_instanceCreditSpecifications - Information about the credit option for CPU usage of an instance.

DescribeInstanceCreditSpecifications, describeInstanceCreditSpecificationsResponse_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:DescribeInstanceCreditSpecificationsResponse', describeInstanceCreditSpecificationsResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceCreditSpecificationsResponse_instanceCreditSpecifications :: Lens' DescribeInstanceCreditSpecificationsResponse (Maybe [InstanceCreditSpecification]) Source #

Information about the credit option for CPU usage of an instance.

describeInstanceCreditSpecificationsResponse_nextToken :: Lens' DescribeInstanceCreditSpecificationsResponse (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.

describeInstanceCreditSpecificationsResponse_httpStatus :: Lens' DescribeInstanceCreditSpecificationsResponse Int Source #

The response's http status code.