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.RDS.DescribeReservedDBInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedDBInstances Source #

See: newDescribeReservedDBInstances smart constructor.

Constructors

DescribeReservedDBInstances'

Fields

dbInstanceClass :: Maybe Text
The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
duration :: Maybe Text
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
filters :: Maybe [Filter]
This parameter isn't currently supported.
leaseId :: Maybe Text
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
marker :: Maybe Text
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
multiAZ :: Maybe Bool
A value that indicates whether to show only those reservations that support Multi-AZ.
offeringType :: Maybe Text
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
productDescription :: Maybe Text
The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
reservedDBInstanceId :: Maybe Text
The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
reservedDBInstancesOfferingId :: Maybe Text
The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Instances

Instances details

ToHeaders DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods toHeaders :: DescribeReservedDBInstances -> [Header] #
ToPath DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods toPath :: DescribeReservedDBInstances -> ByteString #
ToQuery DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods toQuery :: DescribeReservedDBInstances -> QueryString #
AWSPager DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods page :: DescribeReservedDBInstances -> AWSResponse DescribeReservedDBInstances -> Maybe DescribeReservedDBInstances #
AWSRequest DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Associated Types type AWSResponse DescribeReservedDBInstances # Methods request :: (Service -> Service) -> DescribeReservedDBInstances -> Request DescribeReservedDBInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeReservedDBInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReservedDBInstances))) #
Generic DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Associated Types type Rep DescribeReservedDBInstances :: Type -> Type # Methods from :: DescribeReservedDBInstances -> Rep DescribeReservedDBInstances x # to :: Rep DescribeReservedDBInstances x -> DescribeReservedDBInstances #
Read DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods readsPrec :: Int -> ReadS DescribeReservedDBInstances # readList :: ReadS [DescribeReservedDBInstances] # readPrec :: ReadPrec DescribeReservedDBInstances # readListPrec :: ReadPrec [DescribeReservedDBInstances] #
Show DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods showsPrec :: Int -> DescribeReservedDBInstances -> ShowS # show :: DescribeReservedDBInstances -> String # showList :: [DescribeReservedDBInstances] -> ShowS #
NFData DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods rnf :: DescribeReservedDBInstances -> () #
Eq DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods (==) :: DescribeReservedDBInstances -> DescribeReservedDBInstances -> Bool # (/=) :: DescribeReservedDBInstances -> DescribeReservedDBInstances -> Bool #
Hashable DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods hashWithSalt :: Int -> DescribeReservedDBInstances -> Int # hash :: DescribeReservedDBInstances -> Int #
type AWSResponse DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances type AWSResponse DescribeReservedDBInstances = DescribeReservedDBInstancesResponse
type Rep DescribeReservedDBInstances Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances type Rep DescribeReservedDBInstances = D1 ('MetaData "DescribeReservedDBInstances" "Amazonka.RDS.DescribeReservedDBInstances" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeReservedDBInstances'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: (S1 ('MetaSel ('Just "leaseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "productDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reservedDBInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "reservedDBInstancesOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newDescribeReservedDBInstances :: DescribeReservedDBInstances Source #

Create a value of DescribeReservedDBInstances 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:

DescribeReservedDBInstances, describeReservedDBInstances_dbInstanceClass - The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

DescribeReservedDBInstances, describeReservedDBInstances_duration - The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

$sel:filters:DescribeReservedDBInstances', describeReservedDBInstances_filters - This parameter isn't currently supported.

DescribeReservedDBInstances, describeReservedDBInstances_leaseId - The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

DescribeReservedDBInstances, describeReservedDBInstances_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeReservedDBInstances', describeReservedDBInstances_maxRecords - The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeReservedDBInstances, describeReservedDBInstances_multiAZ - A value that indicates whether to show only those reservations that support Multi-AZ.

DescribeReservedDBInstances, describeReservedDBInstances_offeringType - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

DescribeReservedDBInstances, describeReservedDBInstances_productDescription - The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

DescribeReservedDBInstances, describeReservedDBInstances_reservedDBInstanceId - The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

DescribeReservedDBInstances, describeReservedDBInstances_reservedDBInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Request Lenses

describeReservedDBInstances_dbInstanceClass :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

describeReservedDBInstances_duration :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

describeReservedDBInstances_filters :: Lens' DescribeReservedDBInstances (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeReservedDBInstances_leaseId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

describeReservedDBInstances_marker :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedDBInstances_maxRecords :: Lens' DescribeReservedDBInstances (Maybe Int) Source #

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeReservedDBInstances_multiAZ :: Lens' DescribeReservedDBInstances (Maybe Bool) Source #

A value that indicates whether to show only those reservations that support Multi-AZ.

describeReservedDBInstances_offeringType :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

describeReservedDBInstances_productDescription :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

describeReservedDBInstances_reservedDBInstanceId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

describeReservedDBInstances_reservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstances (Maybe Text) Source #

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Destructuring the Response

data DescribeReservedDBInstancesResponse Source #

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

See: newDescribeReservedDBInstancesResponse smart constructor.

Constructors

DescribeReservedDBInstancesResponse'
Fields marker :: Maybe Text An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. reservedDBInstances :: Maybe [ReservedDBInstance] A list of reserved DB instances. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeReservedDBInstancesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Associated Types type Rep DescribeReservedDBInstancesResponse :: Type -> Type # Methods from :: DescribeReservedDBInstancesResponse -> Rep DescribeReservedDBInstancesResponse x # to :: Rep DescribeReservedDBInstancesResponse x -> DescribeReservedDBInstancesResponse #
Read DescribeReservedDBInstancesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods readsPrec :: Int -> ReadS DescribeReservedDBInstancesResponse # readList :: ReadS [DescribeReservedDBInstancesResponse] # readPrec :: ReadPrec DescribeReservedDBInstancesResponse # readListPrec :: ReadPrec [DescribeReservedDBInstancesResponse] #
Show DescribeReservedDBInstancesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods showsPrec :: Int -> DescribeReservedDBInstancesResponse -> ShowS # show :: DescribeReservedDBInstancesResponse -> String # showList :: [DescribeReservedDBInstancesResponse] -> ShowS #
NFData DescribeReservedDBInstancesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods rnf :: DescribeReservedDBInstancesResponse -> () #
Eq DescribeReservedDBInstancesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances Methods (==) :: DescribeReservedDBInstancesResponse -> DescribeReservedDBInstancesResponse -> Bool # (/=) :: DescribeReservedDBInstancesResponse -> DescribeReservedDBInstancesResponse -> Bool #
type Rep DescribeReservedDBInstancesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeReservedDBInstances type Rep DescribeReservedDBInstancesResponse = D1 ('MetaData "DescribeReservedDBInstancesResponse" "Amazonka.RDS.DescribeReservedDBInstances" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeReservedDBInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reservedDBInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedDBInstance])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedDBInstancesResponse Source #

Arguments

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

Create a value of DescribeReservedDBInstancesResponse 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:

DescribeReservedDBInstances, describeReservedDBInstancesResponse_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:reservedDBInstances:DescribeReservedDBInstancesResponse', describeReservedDBInstancesResponse_reservedDBInstances - A list of reserved DB instances.

$sel:httpStatus:DescribeReservedDBInstancesResponse', describeReservedDBInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedDBInstancesResponse_marker :: Lens' DescribeReservedDBInstancesResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedDBInstancesResponse_reservedDBInstances :: Lens' DescribeReservedDBInstancesResponse (Maybe [ReservedDBInstance]) Source #

A list of reserved DB instances.

describeReservedDBInstancesResponse_httpStatus :: Lens' DescribeReservedDBInstancesResponse Int Source #

The response's http status code.