libZSservicesZSamazonka-docdbZSamazonka-docdb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

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

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

  • dbInstanceClass :: Maybe Text

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

  • 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
Eq DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Read DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Show DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Generic DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Associated Types

type Rep DescribeOrderableDBInstanceOptions :: Type -> Type #

NFData DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Hashable DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

AWSPager DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

AWSRequest DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

ToHeaders DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

ToPath DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

ToQuery DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptions = D1 ('MetaData "DescribeOrderableDBInstanceOptions" "Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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)))))
type AWSResponse DescribeOrderableDBInstanceOptions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

newDescribeOrderableDBInstanceOptions Source #

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:

$sel:engineVersion: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.

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

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

$sel:marker: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.

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

$sel:engine:DescribeOrderableDBInstanceOptions', describeOrderableDBInstanceOptions_engine - The name of the engine to retrieve instance options for.

Request Lenses

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_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_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

Instances

Instances details
Eq DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Read DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Show DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

Generic DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

NFData DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions

type Rep DescribeOrderableDBInstanceOptionsResponse = D1 ('MetaData "DescribeOrderableDBInstanceOptionsResponse" "Amazonka.DocumentDB.DescribeOrderableDBInstanceOptions" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeOrderableDBInstanceOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "orderableDBInstanceOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrderableDBInstanceOption])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOrderableDBInstanceOptionsResponse Source #

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:

$sel:orderableDBInstanceOptions:DescribeOrderableDBInstanceOptionsResponse', describeOrderableDBInstanceOptionsResponse_orderableDBInstanceOptions - The options that are available for a particular orderable instance.

$sel:marker: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: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.