Amazonka.DocumentDB.DescribeDBEngineVersions

Returns a list of the available engines.

This operation returns paginated results.

Creating a Request

data DescribeDBEngineVersions

Represents the input to DescribeDBEngineVersions.

See: newDescribeDBEngineVersions smart constructor.

Constructors

DescribeDBEngineVersions'

Fields

• dbParameterGroupFamily :: Maybe Text

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

  Constraints:

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

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

• engine :: Maybe Text

  The database engine to return.

• engineVersion :: Maybe Text

  The database engine version to return.

  Example: 3.6.0

• filters :: Maybe [Filter]

  This parameter is not currently supported.

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

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

• 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

ToHeaders DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

toHeaders :: DescribeDBEngineVersions -> [Header]

ToPath DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

toPath :: DescribeDBEngineVersions -> ByteString

ToQuery DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

toQuery :: DescribeDBEngineVersions -> QueryString

AWSPager DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

page :: DescribeDBEngineVersions -> AWSResponse DescribeDBEngineVersions -> Maybe DescribeDBEngineVersions

AWSRequest DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type AWSResponse DescribeDBEngineVersions

Methods

request :: (Service -> Service) -> DescribeDBEngineVersions -> Request DescribeDBEngineVersions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBEngineVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBEngineVersions)))

Generic DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type Rep DescribeDBEngineVersions :: Type -> Type

Methods

from :: DescribeDBEngineVersions -> Rep DescribeDBEngineVersions x

to :: Rep DescribeDBEngineVersions x -> DescribeDBEngineVersions

Read DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

readsPrec :: Int -> ReadS DescribeDBEngineVersions

readList :: ReadS [DescribeDBEngineVersions]

readPrec :: ReadPrec DescribeDBEngineVersions

readListPrec :: ReadPrec [DescribeDBEngineVersions]

Show DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

showsPrec :: Int -> DescribeDBEngineVersions -> ShowS

show :: DescribeDBEngineVersions -> String

showList :: [DescribeDBEngineVersions] -> ShowS

NFData DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

rnf :: DescribeDBEngineVersions -> ()

Eq DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

(==) :: DescribeDBEngineVersions -> DescribeDBEngineVersions -> Bool

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

Hashable DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

hashWithSalt :: Int -> DescribeDBEngineVersions -> Int

hash :: DescribeDBEngineVersions -> Int

type AWSResponse DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type AWSResponse DescribeDBEngineVersions = DescribeDBEngineVersionsResponse

type Rep DescribeDBEngineVersions

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

type Rep DescribeDBEngineVersions = D1 ('MetaData "DescribeDBEngineVersions" "Amazonka.DocumentDB.DescribeDBEngineVersions" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "DescribeDBEngineVersions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "engine") '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 "listSupportedCharacterSets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "listSupportedTimezones") '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)))))))

newDescribeDBEngineVersions :: DescribeDBEngineVersions

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:

DescribeDBEngineVersions, describeDBEngineVersions_dbParameterGroupFamily - The name of a specific parameter group family to return details for.

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

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

DescribeDBEngineVersions, describeDBEngineVersions_engine - The database engine to return.

DescribeDBEngineVersions, describeDBEngineVersions_engineVersion - The database engine version to return.

Example: 3.6.0

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

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

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

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

describeDBEngineVersions_defaultOnly :: Lens' DescribeDBEngineVersions (Maybe Bool)

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

describeDBEngineVersions_engine :: Lens' DescribeDBEngineVersions (Maybe Text)

The database engine to return.

describeDBEngineVersions_engineVersion :: Lens' DescribeDBEngineVersions (Maybe Text)

The database engine version to return.

Example: 3.6.0

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

This parameter is not currently supported.

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

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

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

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

Destructuring the Response

data DescribeDBEngineVersionsResponse

Represents the output of DescribeDBEngineVersions.

See: newDescribeDBEngineVersionsResponse smart constructor.

Constructors

DescribeDBEngineVersionsResponse'

Fields

• dbEngineVersions :: Maybe [DBEngineVersion]

  Detailed information about one or more engine versions.

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeDBEngineVersionsResponse

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Associated Types

type Rep DescribeDBEngineVersionsResponse :: Type -> Type

Methods

from :: DescribeDBEngineVersionsResponse -> Rep DescribeDBEngineVersionsResponse x

to :: Rep DescribeDBEngineVersionsResponse x -> DescribeDBEngineVersionsResponse

Read DescribeDBEngineVersionsResponse

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

readsPrec :: Int -> ReadS DescribeDBEngineVersionsResponse

readList :: ReadS [DescribeDBEngineVersionsResponse]

readPrec :: ReadPrec DescribeDBEngineVersionsResponse

readListPrec :: ReadPrec [DescribeDBEngineVersionsResponse]

Show DescribeDBEngineVersionsResponse

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

showsPrec :: Int -> DescribeDBEngineVersionsResponse -> ShowS

show :: DescribeDBEngineVersionsResponse -> String

showList :: [DescribeDBEngineVersionsResponse] -> ShowS

NFData DescribeDBEngineVersionsResponse

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

rnf :: DescribeDBEngineVersionsResponse -> ()

Eq DescribeDBEngineVersionsResponse

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

Methods

(==) :: DescribeDBEngineVersionsResponse -> DescribeDBEngineVersionsResponse -> Bool

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

type Rep DescribeDBEngineVersionsResponse

Defined in Amazonka.DocumentDB.DescribeDBEngineVersions

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

newDescribeDBEngineVersionsResponse

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:dbEngineVersions:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_dbEngineVersions - Detailed information about one or more engine versions.

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:httpStatus:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_httpStatus - The response's http status code.

Response Lenses

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

Detailed information about one or more engine versions.

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

describeDBEngineVersionsResponse_httpStatus :: Lens' DescribeDBEngineVersionsResponse Int

The response's http status code.