Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeDBEngineVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the available DB engines.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBEngineVersions Source #

See: newDescribeDBEngineVersions smart constructor.

Constructors

DescribeDBEngineVersions'

Fields

dbParameterGroupFamily :: Maybe Text
The name of a specific DB parameter group family to return details for.
Constraints:
- If supplied, must match an existing DBParameterGroupFamily.
defaultOnly :: Maybe Bool
A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
engine :: Maybe Text
The database engine to return.
Valid Values:
- aurora (for MySQL 5.6-compatible Aurora)
- aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
- ```
aurora-postgresql
```
- ```
mariadb
```
- ```
mysql
```
- ```
oracle-ee
```
- ```
oracle-ee-cdb
```
- ```
oracle-se2
```
- ```
oracle-se2-cdb
```
- ```
postgres
```
- ```
sqlserver-ee
```
- ```
sqlserver-se
```
- ```
sqlserver-ex
```
- ```
sqlserver-web
```
engineVersion :: Maybe Text
The database engine version to return.
Example: 5.1.49
filters :: Maybe [Filter]
A filter that specifies one or more DB engine versions to describe.
Supported filters:
- db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
- engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
- engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
  - ```
  global
```
- ```
multimaster
```
  - ```
  parallelquery
```
- ```
provisioned
```
  - ```
  serverless
```
- engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
- status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
  - ```
  available
```
- ```
deprecated
```
includeAll :: Maybe Bool
A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.
listSupportedCharacterSets :: Maybe Bool
A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.
listSupportedTimezones :: Maybe Bool
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.
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 than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

ToHeaders DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods toHeaders :: DescribeDBEngineVersions -> [Header] #
ToPath DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods toPath :: DescribeDBEngineVersions -> ByteString #
ToQuery DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods toQuery :: DescribeDBEngineVersions -> QueryString #
AWSPager DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods page :: DescribeDBEngineVersions -> AWSResponse DescribeDBEngineVersions -> Maybe DescribeDBEngineVersions #
AWSRequest DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.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 Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Associated Types type Rep DescribeDBEngineVersions :: Type -> Type # Methods from :: DescribeDBEngineVersions -> Rep DescribeDBEngineVersions x # to :: Rep DescribeDBEngineVersions x -> DescribeDBEngineVersions #
Read DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods readsPrec :: Int -> ReadS DescribeDBEngineVersions # readList :: ReadS [DescribeDBEngineVersions] # readPrec :: ReadPrec DescribeDBEngineVersions # readListPrec :: ReadPrec [DescribeDBEngineVersions] #
Show DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods showsPrec :: Int -> DescribeDBEngineVersions -> ShowS # show :: DescribeDBEngineVersions -> String # showList :: [DescribeDBEngineVersions] -> ShowS #
NFData DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods rnf :: DescribeDBEngineVersions -> () #
Eq DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods (==) :: DescribeDBEngineVersions -> DescribeDBEngineVersions -> Bool # (/=) :: DescribeDBEngineVersions -> DescribeDBEngineVersions -> Bool #
Hashable DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods hashWithSalt :: Int -> DescribeDBEngineVersions -> Int # hash :: DescribeDBEngineVersions -> Int #
type AWSResponse DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions type AWSResponse DescribeDBEngineVersions = DescribeDBEngineVersionsResponse
type Rep DescribeDBEngineVersions Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions type Rep DescribeDBEngineVersions = D1 ('MetaData "DescribeDBEngineVersions" "Amazonka.RDS.DescribeDBEngineVersions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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 "includeAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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 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:

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

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

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

DescribeDBEngineVersions, describeDBEngineVersions_engine - The database engine to return.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

DescribeDBEngineVersions, describeDBEngineVersions_engineVersion - The database engine version to return.

Example: 5.1.49

$sel:filters:DescribeDBEngineVersions', describeDBEngineVersions_filters - A filter that specifies one or more DB engine versions to describe.

Supported filters:

db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
- ```
global
```
- ```
multimaster
```
- ```
parallelquery
```
- ```
provisioned
```
- ```
serverless
```
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
- ```
available
```
- ```
deprecated
```

$sel:includeAll:DescribeDBEngineVersions', describeDBEngineVersions_includeAll - A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

$sel:listSupportedCharacterSets:DescribeDBEngineVersions', describeDBEngineVersions_listSupportedCharacterSets - A value that indicates whether to list the supported character sets for each engine version.

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

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

$sel:listSupportedTimezones:DescribeDBEngineVersions', describeDBEngineVersions_listSupportedTimezones - A value that indicates whether to list the supported time zones for each engine version.

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

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

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 than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

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

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

Constraints:

If supplied, must match an existing DBParameterGroupFamily.

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

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

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

The database engine to return.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```
```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

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

The database engine version to return.

Example: 5.1.49

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

A filter that specifies one or more DB engine versions to describe.

Supported filters:

db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
- ```
global
```
- ```
multimaster
```
- ```
parallelquery
```
- ```
provisioned
```
- ```
serverless
```
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
- ```
available
```
- ```
deprecated
```

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

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

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

A value that indicates whether to list the supported character sets for each engine version.

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

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

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

A value that indicates whether to list the supported time zones for each engine version.

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

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

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 than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeDBEngineVersionsResponse Source #

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

See: newDescribeDBEngineVersionsResponse smart constructor.

Constructors

DescribeDBEngineVersionsResponse'
Fields dbEngineVersions :: Maybe [DBEngineVersion] A list of `DBEngineVersion` elements. 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

Instances details

Generic DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Associated Types type Rep DescribeDBEngineVersionsResponse :: Type -> Type # Methods from :: DescribeDBEngineVersionsResponse -> Rep DescribeDBEngineVersionsResponse x # to :: Rep DescribeDBEngineVersionsResponse x -> DescribeDBEngineVersionsResponse #
Read DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods readsPrec :: Int -> ReadS DescribeDBEngineVersionsResponse # readList :: ReadS [DescribeDBEngineVersionsResponse] # readPrec :: ReadPrec DescribeDBEngineVersionsResponse # readListPrec :: ReadPrec [DescribeDBEngineVersionsResponse] #
Show DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods showsPrec :: Int -> DescribeDBEngineVersionsResponse -> ShowS # show :: DescribeDBEngineVersionsResponse -> String # showList :: [DescribeDBEngineVersionsResponse] -> ShowS #
NFData DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods rnf :: DescribeDBEngineVersionsResponse -> () #
Eq DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions Methods (==) :: DescribeDBEngineVersionsResponse -> DescribeDBEngineVersionsResponse -> Bool # (/=) :: DescribeDBEngineVersionsResponse -> DescribeDBEngineVersionsResponse -> Bool #
type Rep DescribeDBEngineVersionsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBEngineVersions type Rep DescribeDBEngineVersionsResponse = D1 ('MetaData "DescribeDBEngineVersionsResponse" "Amazonka.RDS.DescribeDBEngineVersions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" '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 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:dbEngineVersions:DescribeDBEngineVersionsResponse', describeDBEngineVersionsResponse_dbEngineVersions - A list of DBEngineVersion elements.

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]) Source #

A list of DBEngineVersion elements.

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_httpStatus :: Lens' DescribeDBEngineVersionsResponse Int Source #

The response's http status code.