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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists available reserved DB instance offerings.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedDBInstancesOfferings Source #

See: newDescribeReservedDBInstancesOfferings smart constructor.

Constructors

DescribeReservedDBInstancesOfferings'

Fields

dbInstanceClass :: Maybe Text
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
duration :: Maybe Text
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.
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
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
The results show offerings that partially match the filter value.
reservedDBInstancesOfferingId :: Maybe Text
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Instances

Instances details

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

newDescribeReservedDBInstancesOfferings :: DescribeReservedDBInstancesOfferings Source #

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

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings_dbInstanceClass - The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings_duration - 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:DescribeReservedDBInstancesOfferings', describeReservedDBInstancesOfferings_filters - This parameter isn't currently supported.

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings_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:DescribeReservedDBInstancesOfferings', describeReservedDBInstancesOfferings_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.

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

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings_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"

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings_productDescription - Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The results show offerings that partially match the filter value.

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings_reservedDBInstancesOfferingId - The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Request Lenses

describeReservedDBInstancesOfferings_dbInstanceClass :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

describeReservedDBInstancesOfferings_duration :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

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

Valid Values: 1 | 3 | 31536000 | 94608000

describeReservedDBInstancesOfferings_filters :: Lens' DescribeReservedDBInstancesOfferings (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeReservedDBInstancesOfferings_marker :: Lens' DescribeReservedDBInstancesOfferings (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.

describeReservedDBInstancesOfferings_maxRecords :: Lens' DescribeReservedDBInstancesOfferings (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.

describeReservedDBInstancesOfferings_multiAZ :: Lens' DescribeReservedDBInstancesOfferings (Maybe Bool) Source #

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

describeReservedDBInstancesOfferings_offeringType :: Lens' DescribeReservedDBInstancesOfferings (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"

describeReservedDBInstancesOfferings_productDescription :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

The results show offerings that partially match the filter value.

describeReservedDBInstancesOfferings_reservedDBInstancesOfferingId :: Lens' DescribeReservedDBInstancesOfferings (Maybe Text) Source #

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

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Destructuring the Response

data DescribeReservedDBInstancesOfferingsResponse Source #

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

See: newDescribeReservedDBInstancesOfferingsResponse smart constructor.

Constructors

DescribeReservedDBInstancesOfferingsResponse'
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`. reservedDBInstancesOfferings :: Maybe [ReservedDBInstancesOffering] A list of reserved DB instance offerings. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeReservedDBInstancesOfferingsResponse Source #

Arguments

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

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

DescribeReservedDBInstancesOfferings, describeReservedDBInstancesOfferingsResponse_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:reservedDBInstancesOfferings:DescribeReservedDBInstancesOfferingsResponse', describeReservedDBInstancesOfferingsResponse_reservedDBInstancesOfferings - A list of reserved DB instance offerings.

$sel:httpStatus:DescribeReservedDBInstancesOfferingsResponse', describeReservedDBInstancesOfferingsResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedDBInstancesOfferingsResponse_marker :: Lens' DescribeReservedDBInstancesOfferingsResponse (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.

describeReservedDBInstancesOfferingsResponse_reservedDBInstancesOfferings :: Lens' DescribeReservedDBInstancesOfferingsResponse (Maybe [ReservedDBInstancesOffering]) Source #

A list of reserved DB instance offerings.

describeReservedDBInstancesOfferingsResponse_httpStatus :: Lens' DescribeReservedDBInstancesOfferingsResponse Int Source #

The response's http status code.