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

Description

Returns a list of the available engines.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBEngineVersions Source #

Represents the input to DescribeDBEngineVersions.

See: newDescribeDBEngineVersions smart constructor.

Constructors

DescribeDBEngineVersions' 

Fields

  • engineVersion :: Maybe Text

    The database engine version to return.

    Example: 3.6.0

  • listSupportedTimezones :: Maybe Bool

    If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

  • defaultOnly :: Maybe Bool

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

  • filters :: Maybe [Filter]

    This parameter is not currently supported.

  • engine :: Maybe Text

    The database engine to return.

  • dbParameterGroupFamily :: Maybe Text

    The name of a specific parameter group family to return details for.

    Constraints:

    • If provided, must match an existing DBParameterGroupFamily.
  • listSupportedCharacterSets :: Maybe Bool

    If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

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

Instances

Instances details
Eq DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Read DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Show DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Generic DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type Rep DescribeDBEngineVersions :: Type -> Type #

NFData DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Hashable DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

AWSPager DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

AWSRequest DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

ToHeaders DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

ToPath DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

ToQuery DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersions = D1 ('MetaData "DescribeDBEngineVersions" "Amazonka.DocumentDB.DescribeDBEngineVersions" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeDBEngineVersions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "listSupportedTimezones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "defaultOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :*: ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "listSupportedCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))
type AWSResponse DescribeDBEngineVersions Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

newDescribeDBEngineVersions :: DescribeDBEngineVersions Source #

Create a value of DescribeDBEngineVersions 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:DescribeDBEngineVersions', describeDBEngineVersions_engineVersion - The database engine version to return.

Example: 3.6.0

$sel:listSupportedTimezones:DescribeDBEngineVersions', describeDBEngineVersions_listSupportedTimezones - If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

$sel:defaultOnly:DescribeDBEngineVersions', describeDBEngineVersions_defaultOnly - Indicates that only the default version of the specified engine or engine and major version combination is returned.

$sel:filters:DescribeDBEngineVersions', describeDBEngineVersions_filters - This parameter is not currently supported.

$sel:engine:DescribeDBEngineVersions', describeDBEngineVersions_engine - The database engine to return.

$sel:dbParameterGroupFamily:DescribeDBEngineVersions', describeDBEngineVersions_dbParameterGroupFamily - The name of a specific parameter group family to return details for.

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

$sel:listSupportedCharacterSets:DescribeDBEngineVersions', describeDBEngineVersions_listSupportedCharacterSets - If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

$sel:marker:DescribeDBEngineVersions', describeDBEngineVersions_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:DescribeDBEngineVersions', describeDBEngineVersions_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.

Request Lenses

describeDBEngineVersions_engineVersion :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The database engine version to return.

Example: 3.6.0

describeDBEngineVersions_listSupportedTimezones :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

describeDBEngineVersions_defaultOnly :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

Indicates that only the default version of the specified engine or engine and major version combination is returned.

describeDBEngineVersions_filters :: Lens' DescribeDBEngineVersions (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBEngineVersions_dbParameterGroupFamily :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The name of a specific parameter group family to return details for.

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

describeDBEngineVersions_listSupportedCharacterSets :: Lens' DescribeDBEngineVersions (Maybe Bool) Source #

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

describeDBEngineVersions_marker :: Lens' DescribeDBEngineVersions (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.

describeDBEngineVersions_maxRecords :: Lens' DescribeDBEngineVersions (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.

Destructuring the Response

data DescribeDBEngineVersionsResponse Source #

Represents the output of DescribeDBEngineVersions.

See: newDescribeDBEngineVersionsResponse smart constructor.

Constructors

DescribeDBEngineVersionsResponse' 

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.

  • dbEngineVersions :: Maybe [DBEngineVersion]

    Detailed information about one or more engine versions.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Read DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Show DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Generic DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type Rep DescribeDBEngineVersionsResponse :: Type -> Type #

NFData DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersionsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

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

newDescribeDBEngineVersionsResponse Source #

Create a value of DescribeDBEngineVersionsResponse 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:marker:DescribeDBEngineVersions', describeDBEngineVersionsResponse_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:dbEngineVersions:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_dbEngineVersions - Detailed information about one or more engine versions.

$sel:httpStatus:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBEngineVersionsResponse_marker :: Lens' DescribeDBEngineVersionsResponse (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.