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.DocumentDB.DescribeOrderableDBInstanceOptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of orderable instance options for the specified engine.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeOrderableDBInstanceOptions Source #

Represents the input to DescribeOrderableDBInstanceOptions.

See: newDescribeOrderableDBInstanceOptions smart constructor.

Constructors

DescribeOrderableDBInstanceOptions'

Fields

dbInstanceClass :: Maybe Text
The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.
engineVersion :: Maybe Text
The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.
filters :: Maybe [Filter]
This parameter is not currently supported.
licenseModel :: Maybe Text
The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.
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 records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
vpc :: Maybe Bool
The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
engine :: Text
The name of the engine to retrieve instance options for.

Instances

Instances details

ToHeaders DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods toHeaders :: DescribeOrderableDBInstanceOptions -> [Header] #
ToPath DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods toPath :: DescribeOrderableDBInstanceOptions -> ByteString #
ToQuery DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods toQuery :: DescribeOrderableDBInstanceOptions -> QueryString #
AWSPager DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods page :: DescribeOrderableDBInstanceOptions -> AWSResponse DescribeOrderableDBInstanceOptions -> Maybe DescribeOrderableDBInstanceOptions #
AWSRequest DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Associated Types type AWSResponse DescribeOrderableDBInstanceOptions # Methods request :: (Service -> Service) -> DescribeOrderableDBInstanceOptions -> Request DescribeOrderableDBInstanceOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeOrderableDBInstanceOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOrderableDBInstanceOptions))) #
Generic DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Associated Types type Rep DescribeOrderableDBInstanceOptions :: Type -> Type # Methods from :: DescribeOrderableDBInstanceOptions -> Rep DescribeOrderableDBInstanceOptions x # to :: Rep DescribeOrderableDBInstanceOptions x -> DescribeOrderableDBInstanceOptions #
Read DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods readsPrec :: Int -> ReadS DescribeOrderableDBInstanceOptions # readList :: ReadS [DescribeOrderableDBInstanceOptions] # readPrec :: ReadPrec DescribeOrderableDBInstanceOptions # readListPrec :: ReadPrec [DescribeOrderableDBInstanceOptions] #
Show DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods showsPrec :: Int -> DescribeOrderableDBInstanceOptions -> ShowS # show :: DescribeOrderableDBInstanceOptions -> String # showList :: [DescribeOrderableDBInstanceOptions] -> ShowS #
NFData DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods rnf :: DescribeOrderableDBInstanceOptions -> () #
Eq DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods (==) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool # (/=) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool #
Hashable DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions Methods hashWithSalt :: Int -> DescribeOrderableDBInstanceOptions -> Int # hash :: DescribeOrderableDBInstanceOptions -> Int #
type AWSResponse DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions type AWSResponse DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptionsResponse
type Rep DescribeOrderableDBInstanceOptions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions type Rep DescribeOrderableDBInstanceOptions = D1 ('MetaData "DescribeOrderableDBInstanceOptions" "Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "licenseModel") '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 "vpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeOrderableDBInstanceOptions Source #

Arguments

:: Text	`DescribeOrderableDBInstanceOptions`
-> DescribeOrderableDBInstanceOptions

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

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_dbInstanceClass - The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_engineVersion - The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

$sel:filters:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_filters - This parameter is not currently supported.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_licenseModel - The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_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:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_vpc - The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptions_engine - The name of the engine to retrieve instance options for.

Request Lenses

describeOrderableDBInstanceOptions_dbInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

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

describeOrderableDBInstanceOptions_engineVersion :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

describeOrderableDBInstanceOptions_filters :: Lens' DescribeOrderableDBInstanceOptions (Maybe [Filter]) Source #

This parameter is not currently supported.

describeOrderableDBInstanceOptions_licenseModel :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text) Source #

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

describeOrderableDBInstanceOptions_marker :: Lens' DescribeOrderableDBInstanceOptions (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.

describeOrderableDBInstanceOptions_maxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

describeOrderableDBInstanceOptions_vpc :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool) Source #

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

describeOrderableDBInstanceOptions_engine :: Lens' DescribeOrderableDBInstanceOptions Text Source #

The name of the engine to retrieve instance options for.

Destructuring the Response

data DescribeOrderableDBInstanceOptionsResponse Source #

Represents the output of DescribeOrderableDBInstanceOptions.

See: newDescribeOrderableDBInstanceOptionsResponse smart constructor.

Constructors

DescribeOrderableDBInstanceOptionsResponse'

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.
orderableDBInstanceOptions :: Maybe [OrderableDBInstanceOption]
The options that are available for a particular orderable instance.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeOrderableDBInstanceOptionsResponse Source #

Arguments

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

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

DescribeOrderableDBInstanceOptions, describeOrderableDBInstanceOptionsResponse_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:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions - The options that are available for a particular orderable instance.

$sel:httpStatus:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeOrderableDBInstanceOptionsResponse_marker :: Lens' DescribeOrderableDBInstanceOptionsResponse (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.

describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe [OrderableDBInstanceOption]) Source #

The options that are available for a particular orderable instance.

describeOrderableDBInstanceOptionsResponse_httpStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int Source #

The response's http status code.