Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.DescribeDBEngineVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Methods (==) :: DescribeDBEngineVersions -> DescribeDBEngineVersions -> Bool # (/=) :: DescribeDBEngineVersions -> DescribeDBEngineVersions -> Bool #
Read DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods readsPrec :: Int -> ReadS DescribeDBEngineVersions # readList :: ReadS [DescribeDBEngineVersions] # readPrec :: ReadPrec DescribeDBEngineVersions # readListPrec :: ReadPrec [DescribeDBEngineVersions] #
Show DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods showsPrec :: Int -> DescribeDBEngineVersions -> ShowS # show :: DescribeDBEngineVersions -> String # showList :: [DescribeDBEngineVersions] -> ShowS #
Generic DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Associated Types type Rep DescribeDBEngineVersions :: Type -> Type # Methods from :: DescribeDBEngineVersions -> Rep DescribeDBEngineVersions x # to :: Rep DescribeDBEngineVersions x -> DescribeDBEngineVersions #
NFData DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods rnf :: DescribeDBEngineVersions -> () #
Hashable DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods hashWithSalt :: Int -> DescribeDBEngineVersions -> Int # hash :: DescribeDBEngineVersions -> Int #
AWSPager DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods page :: DescribeDBEngineVersions -> AWSResponse DescribeDBEngineVersions -> Maybe DescribeDBEngineVersions #
AWSRequest DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Associated Types type AWSResponse DescribeDBEngineVersions # Methods request :: DescribeDBEngineVersions -> Request DescribeDBEngineVersions # response :: MonadResource m => Logger -> Service -> Proxy DescribeDBEngineVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBEngineVersions))) #
ToHeaders DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods toHeaders :: DescribeDBEngineVersions -> [Header] #
ToPath DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods toPath :: DescribeDBEngineVersions -> ByteString #
ToQuery DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods toQuery :: DescribeDBEngineVersions -> QueryString #
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 type AWSResponse DescribeDBEngineVersions = DescribeDBEngineVersionsResponse

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_engine :: Lens' DescribeDBEngineVersions (Maybe Text) Source #

The database engine to return.

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 Methods (==) :: DescribeDBEngineVersionsResponse -> DescribeDBEngineVersionsResponse -> Bool # (/=) :: DescribeDBEngineVersionsResponse -> DescribeDBEngineVersionsResponse -> Bool #
Read DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods readsPrec :: Int -> ReadS DescribeDBEngineVersionsResponse # readList :: ReadS [DescribeDBEngineVersionsResponse] # readPrec :: ReadPrec DescribeDBEngineVersionsResponse # readListPrec :: ReadPrec [DescribeDBEngineVersionsResponse] #
Show DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods showsPrec :: Int -> DescribeDBEngineVersionsResponse -> ShowS # show :: DescribeDBEngineVersionsResponse -> String # showList :: [DescribeDBEngineVersionsResponse] -> ShowS #
Generic DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Associated Types type Rep DescribeDBEngineVersionsResponse :: Type -> Type # Methods from :: DescribeDBEngineVersionsResponse -> Rep DescribeDBEngineVersionsResponse x # to :: Rep DescribeDBEngineVersionsResponse x -> DescribeDBEngineVersionsResponse #
NFData DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBEngineVersions Methods rnf :: DescribeDBEngineVersionsResponse -> () #
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 #

Arguments

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

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.

describeDBEngineVersionsResponse_dbEngineVersions :: Lens' DescribeDBEngineVersionsResponse (Maybe [DBEngineVersion]) Source #

Detailed information about one or more engine versions.

describeDBEngineVersionsResponse_httpStatus :: Lens' DescribeDBEngineVersionsResponse Int Source #

The response's http status code.