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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data DescribeReservedInstances Source #

Contains the parameters for DescribeReservedInstances.

See: newDescribeReservedInstances smart constructor.

Constructors

DescribeReservedInstances'

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]
One or more filters.
- availability-zone - The Availability Zone where the Reserved Instance can be used.
- duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
- end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
- fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
- instance-type - The instance type that is covered by the reservation.
- scope - The scope of the Reserved Instance (Region or Availability Zone).
- product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
- reserved-instances-id - The ID of the Reserved Instance.
- start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
- state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
offeringClass :: Maybe OfferingClassType
Describes whether the Reserved Instance is Standard or Convertible.
offeringType :: Maybe OfferingTypeValues
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
reservedInstancesIds :: Maybe [Text]
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.

Instances

Instances details

ToHeaders DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods toHeaders :: DescribeReservedInstances -> [Header] #
ToPath DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods toPath :: DescribeReservedInstances -> ByteString #
ToQuery DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods toQuery :: DescribeReservedInstances -> QueryString #
AWSRequest DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Associated Types type AWSResponse DescribeReservedInstances # Methods request :: (Service -> Service) -> DescribeReservedInstances -> Request DescribeReservedInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeReservedInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReservedInstances))) #
Generic DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Associated Types type Rep DescribeReservedInstances :: Type -> Type # Methods from :: DescribeReservedInstances -> Rep DescribeReservedInstances x # to :: Rep DescribeReservedInstances x -> DescribeReservedInstances #
Read DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods readsPrec :: Int -> ReadS DescribeReservedInstances # readList :: ReadS [DescribeReservedInstances] # readPrec :: ReadPrec DescribeReservedInstances # readListPrec :: ReadPrec [DescribeReservedInstances] #
Show DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods showsPrec :: Int -> DescribeReservedInstances -> ShowS # show :: DescribeReservedInstances -> String # showList :: [DescribeReservedInstances] -> ShowS #
NFData DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods rnf :: DescribeReservedInstances -> () #
Eq DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods (==) :: DescribeReservedInstances -> DescribeReservedInstances -> Bool # (/=) :: DescribeReservedInstances -> DescribeReservedInstances -> Bool #
Hashable DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances Methods hashWithSalt :: Int -> DescribeReservedInstances -> Int # hash :: DescribeReservedInstances -> Int #
type AWSResponse DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances type AWSResponse DescribeReservedInstances = DescribeReservedInstancesResponse
type Rep DescribeReservedInstances Source #
Instance details Defined in Amazonka.EC2.DescribeReservedInstances type Rep DescribeReservedInstances = D1 ('MetaData "DescribeReservedInstances" "Amazonka.EC2.DescribeReservedInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeReservedInstances'" '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 "offeringClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfferingClassType)) :: (S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfferingTypeValues)) :: S1 ('MetaSel ('Just "reservedInstancesIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeReservedInstances :: DescribeReservedInstances Source #

Create a value of DescribeReservedInstances 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:DescribeReservedInstances', describeReservedInstances_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:DescribeReservedInstances', describeReservedInstances_filters - One or more filters.

availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

DescribeReservedInstances, describeReservedInstances_offeringClass - Describes whether the Reserved Instance is Standard or Convertible.

DescribeReservedInstances, describeReservedInstances_offeringType - The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

DescribeReservedInstances, describeReservedInstances_reservedInstancesIds - One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Request Lenses

describeReservedInstances_dryRun :: Lens' DescribeReservedInstances (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.

describeReservedInstances_filters :: Lens' DescribeReservedInstances (Maybe [Filter]) Source #

One or more filters.

availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat Enterprise Linux with HA (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

describeReservedInstances_offeringClass :: Lens' DescribeReservedInstances (Maybe OfferingClassType) Source #

Describes whether the Reserved Instance is Standard or Convertible.

describeReservedInstances_offeringType :: Lens' DescribeReservedInstances (Maybe OfferingTypeValues) Source #

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

describeReservedInstances_reservedInstancesIds :: Lens' DescribeReservedInstances (Maybe [Text]) Source #

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Destructuring the Response

data DescribeReservedInstancesResponse Source #

Contains the output for DescribeReservedInstances.

See: newDescribeReservedInstancesResponse smart constructor.

Constructors

DescribeReservedInstancesResponse'
Fields reservedInstances :: Maybe [ReservedInstances] A list of Reserved Instances. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeReservedInstancesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeReservedInstancesResponse'`
-> DescribeReservedInstancesResponse

Create a value of DescribeReservedInstancesResponse 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:reservedInstances:DescribeReservedInstancesResponse', describeReservedInstancesResponse_reservedInstances - A list of Reserved Instances.

$sel:httpStatus:DescribeReservedInstancesResponse', describeReservedInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedInstancesResponse_reservedInstances :: Lens' DescribeReservedInstancesResponse (Maybe [ReservedInstances]) Source #

A list of Reserved Instances.

describeReservedInstancesResponse_httpStatus :: Lens' DescribeReservedInstancesResponse Int Source #

The response's http status code.