Network.AWS.RDS.DescribeOrderableDBInstanceOptions

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

This operation returns paginated results.

Creating a Request

describeOrderableDBInstanceOptions

Arguments

:: Text

dodioEngine

-> DescribeOrderableDBInstanceOptions

Creates a value of DescribeOrderableDBInstanceOptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dodioEngineVersion - The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
• dodioFilters - This parameter is not currently supported.
• dodioDBInstanceClass - The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
• dodioLicenseModel - The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
• dodioMarker - An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
• dodioMaxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
• dodioVPC - The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
• dodioEngine - The name of the engine to retrieve DB instance options for.

data DescribeOrderableDBInstanceOptions

See: describeOrderableDBInstanceOptions smart constructor.

Instances

Eq DescribeOrderableDBInstanceOptions

Methods

(==) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool

(/=) :: DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions -> Bool

Data DescribeOrderableDBInstanceOptions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeOrderableDBInstanceOptions -> c DescribeOrderableDBInstanceOptions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeOrderableDBInstanceOptions

toConstr :: DescribeOrderableDBInstanceOptions -> Constr

dataTypeOf :: DescribeOrderableDBInstanceOptions -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeOrderableDBInstanceOptions)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeOrderableDBInstanceOptions)

gmapT :: (forall b. Data b => b -> b) -> DescribeOrderableDBInstanceOptions -> DescribeOrderableDBInstanceOptions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrderableDBInstanceOptions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrderableDBInstanceOptions -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeOrderableDBInstanceOptions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeOrderableDBInstanceOptions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeOrderableDBInstanceOptions -> m DescribeOrderableDBInstanceOptions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrderableDBInstanceOptions -> m DescribeOrderableDBInstanceOptions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrderableDBInstanceOptions -> m DescribeOrderableDBInstanceOptions

Read DescribeOrderableDBInstanceOptions

Methods

readsPrec :: Int -> ReadS DescribeOrderableDBInstanceOptions

readList :: ReadS [DescribeOrderableDBInstanceOptions]

readPrec :: ReadPrec DescribeOrderableDBInstanceOptions

readListPrec :: ReadPrec [DescribeOrderableDBInstanceOptions]

Show DescribeOrderableDBInstanceOptions

Methods

showsPrec :: Int -> DescribeOrderableDBInstanceOptions -> ShowS

show :: DescribeOrderableDBInstanceOptions -> String

showList :: [DescribeOrderableDBInstanceOptions] -> ShowS

Generic DescribeOrderableDBInstanceOptions

Associated Types

type Rep DescribeOrderableDBInstanceOptions :: * -> *

Methods

from :: DescribeOrderableDBInstanceOptions -> Rep DescribeOrderableDBInstanceOptions x

to :: Rep DescribeOrderableDBInstanceOptions x -> DescribeOrderableDBInstanceOptions

Hashable DescribeOrderableDBInstanceOptions

Methods

hashWithSalt :: Int -> DescribeOrderableDBInstanceOptions -> Int

hash :: DescribeOrderableDBInstanceOptions -> Int

NFData DescribeOrderableDBInstanceOptions

Methods

rnf :: DescribeOrderableDBInstanceOptions -> ()

AWSPager DescribeOrderableDBInstanceOptions

Methods

page :: DescribeOrderableDBInstanceOptions -> Rs DescribeOrderableDBInstanceOptions -> Maybe DescribeOrderableDBInstanceOptions

AWSRequest DescribeOrderableDBInstanceOptions

Associated Types

type Rs DescribeOrderableDBInstanceOptions :: *

Methods

request :: DescribeOrderableDBInstanceOptions -> Request DescribeOrderableDBInstanceOptions

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeOrderableDBInstanceOptions -> ClientResponse -> m (Response DescribeOrderableDBInstanceOptions)

ToHeaders DescribeOrderableDBInstanceOptions

Methods

toHeaders :: DescribeOrderableDBInstanceOptions -> [Header]

ToPath DescribeOrderableDBInstanceOptions

Methods

toPath :: DescribeOrderableDBInstanceOptions -> ByteString

ToQuery DescribeOrderableDBInstanceOptions

Methods

toQuery :: DescribeOrderableDBInstanceOptions -> QueryString

type Rep DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptions = D1 * (MetaData "DescribeOrderableDBInstanceOptions" "Network.AWS.RDS.DescribeOrderableDBInstanceOptions" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeOrderableDBInstanceOptions'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dodioEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dodioFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dodioDBInstanceClass") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dodioLicenseModel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dodioMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dodioMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dodioVPC") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_dodioEngine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs DescribeOrderableDBInstanceOptions

type Rs DescribeOrderableDBInstanceOptions = DescribeOrderableDBInstanceOptionsResponse

Request Lenses

dodioEngineVersion :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

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

dodioFilters :: Lens' DescribeOrderableDBInstanceOptions [Filter]

This parameter is not currently supported.

dodioDBInstanceClass :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

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

dodioLicenseModel :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

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

dodioMarker :: Lens' DescribeOrderableDBInstanceOptions (Maybe Text)

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

dodioMaxRecords :: Lens' DescribeOrderableDBInstanceOptions (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

dodioVPC :: Lens' DescribeOrderableDBInstanceOptions (Maybe Bool)

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

dodioEngine :: Lens' DescribeOrderableDBInstanceOptions Text

The name of the engine to retrieve DB instance options for.

Destructuring the Response

describeOrderableDBInstanceOptionsResponse

Arguments

:: Int

dodiorsResponseStatus

-> DescribeOrderableDBInstanceOptionsResponse

Creates a value of DescribeOrderableDBInstanceOptionsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dodiorsOrderableDBInstanceOptions - An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
• dodiorsMarker - An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
• dodiorsResponseStatus - -- | The response status code.

data DescribeOrderableDBInstanceOptionsResponse

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

See: describeOrderableDBInstanceOptionsResponse smart constructor.

Instances

Eq DescribeOrderableDBInstanceOptionsResponse

Methods

(==) :: DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse -> Bool

(/=) :: DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse -> Bool

Data DescribeOrderableDBInstanceOptionsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeOrderableDBInstanceOptionsResponse -> c DescribeOrderableDBInstanceOptionsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeOrderableDBInstanceOptionsResponse

toConstr :: DescribeOrderableDBInstanceOptionsResponse -> Constr

dataTypeOf :: DescribeOrderableDBInstanceOptionsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeOrderableDBInstanceOptionsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeOrderableDBInstanceOptionsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeOrderableDBInstanceOptionsResponse -> DescribeOrderableDBInstanceOptionsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrderableDBInstanceOptionsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOrderableDBInstanceOptionsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeOrderableDBInstanceOptionsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeOrderableDBInstanceOptionsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeOrderableDBInstanceOptionsResponse -> m DescribeOrderableDBInstanceOptionsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrderableDBInstanceOptionsResponse -> m DescribeOrderableDBInstanceOptionsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOrderableDBInstanceOptionsResponse -> m DescribeOrderableDBInstanceOptionsResponse

Read DescribeOrderableDBInstanceOptionsResponse

Methods

readsPrec :: Int -> ReadS DescribeOrderableDBInstanceOptionsResponse

readList :: ReadS [DescribeOrderableDBInstanceOptionsResponse]

readPrec :: ReadPrec DescribeOrderableDBInstanceOptionsResponse

readListPrec :: ReadPrec [DescribeOrderableDBInstanceOptionsResponse]

Show DescribeOrderableDBInstanceOptionsResponse

Methods

showsPrec :: Int -> DescribeOrderableDBInstanceOptionsResponse -> ShowS

show :: DescribeOrderableDBInstanceOptionsResponse -> String

showList :: [DescribeOrderableDBInstanceOptionsResponse] -> ShowS

Generic DescribeOrderableDBInstanceOptionsResponse

Associated Types

type Rep DescribeOrderableDBInstanceOptionsResponse :: * -> *

Methods

from :: DescribeOrderableDBInstanceOptionsResponse -> Rep DescribeOrderableDBInstanceOptionsResponse x

to :: Rep DescribeOrderableDBInstanceOptionsResponse x -> DescribeOrderableDBInstanceOptionsResponse

NFData DescribeOrderableDBInstanceOptionsResponse

Methods

rnf :: DescribeOrderableDBInstanceOptionsResponse -> ()

type Rep DescribeOrderableDBInstanceOptionsResponse

type Rep DescribeOrderableDBInstanceOptionsResponse = D1 * (MetaData "DescribeOrderableDBInstanceOptionsResponse" "Network.AWS.RDS.DescribeOrderableDBInstanceOptions" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeOrderableDBInstanceOptionsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dodiorsOrderableDBInstanceOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OrderableDBInstanceOption]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dodiorsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dodiorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dodiorsOrderableDBInstanceOptions :: Lens' DescribeOrderableDBInstanceOptionsResponse [OrderableDBInstanceOption]

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

dodiorsMarker :: Lens' DescribeOrderableDBInstanceOptionsResponse (Maybe Text)

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

dodiorsResponseStatus :: Lens' DescribeOrderableDBInstanceOptionsResponse Int

• - | The response status code.