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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the default engine and system parameter information for the specified database engine.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEngineDefaultParameters Source #

See: newDescribeEngineDefaultParameters smart constructor.

Constructors

DescribeEngineDefaultParameters'

Fields

filters :: Maybe [Filter]
This parameter isn't currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeEngineDefaultParameters 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 called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.

dbParameterGroupFamily :: Text

The name of the DB parameter group family.

Valid Values:

```
aurora5.6
```
```
aurora-mysql5.7
```
```
aurora-mysql8.0
```
```
aurora-postgresql10
```
```
aurora-postgresql11
```
```
aurora-postgresql12
```
```
aurora-postgresql13
```
```
aurora-postgresql14
```
```
custom-oracle-ee-19
```
```
mariadb10.2
```
```
mariadb10.3
```
```
mariadb10.4
```
```
mariadb10.5
```
```
mariadb10.6
```
```
mysql5.7
```
```
mysql8.0
```
```
oracle-ee-19
```
```
oracle-ee-cdb-19
```
```
oracle-ee-cdb-21
```
```
oracle-se2-19
```
```
oracle-se2-cdb-19
```
```
oracle-se2-cdb-21
```
```
postgres10
```
```
postgres11
```
```
postgres12
```
```
postgres13
```
```
postgres14
```
```
sqlserver-ee-11.0
```
```
sqlserver-ee-12.0
```
```
sqlserver-ee-13.0
```
```
sqlserver-ee-14.0
```
```
sqlserver-ee-15.0
```
```
sqlserver-ex-11.0
```
```
sqlserver-ex-12.0
```
```
sqlserver-ex-13.0
```
```
sqlserver-ex-14.0
```
```
sqlserver-ex-15.0
```
```
sqlserver-se-11.0
```
```
sqlserver-se-12.0
```
```
sqlserver-se-13.0
```
```
sqlserver-se-14.0
```
```
sqlserver-se-15.0
```
```
sqlserver-web-11.0
```
```
sqlserver-web-12.0
```
```
sqlserver-web-13.0
```
```
sqlserver-web-14.0
```
```
sqlserver-web-15.0
```

Instances

Instances details

ToHeaders DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods toHeaders :: DescribeEngineDefaultParameters -> [Header] #
ToPath DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods toPath :: DescribeEngineDefaultParameters -> ByteString #
ToQuery DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods toQuery :: DescribeEngineDefaultParameters -> QueryString #
AWSPager DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods page :: DescribeEngineDefaultParameters -> AWSResponse DescribeEngineDefaultParameters -> Maybe DescribeEngineDefaultParameters #
AWSRequest DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Associated Types type AWSResponse DescribeEngineDefaultParameters # Methods request :: (Service -> Service) -> DescribeEngineDefaultParameters -> Request DescribeEngineDefaultParameters # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEngineDefaultParameters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEngineDefaultParameters))) #
Generic DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Associated Types type Rep DescribeEngineDefaultParameters :: Type -> Type # Methods from :: DescribeEngineDefaultParameters -> Rep DescribeEngineDefaultParameters x # to :: Rep DescribeEngineDefaultParameters x -> DescribeEngineDefaultParameters #
Read DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods readsPrec :: Int -> ReadS DescribeEngineDefaultParameters # readList :: ReadS [DescribeEngineDefaultParameters] # readPrec :: ReadPrec DescribeEngineDefaultParameters # readListPrec :: ReadPrec [DescribeEngineDefaultParameters] #
Show DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods showsPrec :: Int -> DescribeEngineDefaultParameters -> ShowS # show :: DescribeEngineDefaultParameters -> String # showList :: [DescribeEngineDefaultParameters] -> ShowS #
NFData DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods rnf :: DescribeEngineDefaultParameters -> () #
Eq DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods (==) :: DescribeEngineDefaultParameters -> DescribeEngineDefaultParameters -> Bool # (/=) :: DescribeEngineDefaultParameters -> DescribeEngineDefaultParameters -> Bool #
Hashable DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods hashWithSalt :: Int -> DescribeEngineDefaultParameters -> Int # hash :: DescribeEngineDefaultParameters -> Int #
type AWSResponse DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters type AWSResponse DescribeEngineDefaultParameters = DescribeEngineDefaultParametersResponse
type Rep DescribeEngineDefaultParameters Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters type Rep DescribeEngineDefaultParameters = D1 ('MetaData "DescribeEngineDefaultParameters" "Amazonka.RDS.DescribeEngineDefaultParameters" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeEngineDefaultParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "dbParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeEngineDefaultParameters Source #

Arguments

:: Text	`DescribeEngineDefaultParameters`
-> DescribeEngineDefaultParameters

Create a value of DescribeEngineDefaultParameters 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:filters:DescribeEngineDefaultParameters', describeEngineDefaultParameters_filters - This parameter isn't currently supported.

DescribeEngineDefaultParameters, describeEngineDefaultParameters_marker - An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeEngineDefaultParameters', describeEngineDefaultParameters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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.

DescribeEngineDefaultParameters, describeEngineDefaultParameters_dbParameterGroupFamily - The name of the DB parameter group family.

Valid Values:

```
aurora5.6
```
```
aurora-mysql5.7
```
```
aurora-mysql8.0
```
```
aurora-postgresql10
```
```
aurora-postgresql11
```
```
aurora-postgresql12
```
```
aurora-postgresql13
```
```
aurora-postgresql14
```
```
custom-oracle-ee-19
```
```
mariadb10.2
```
```
mariadb10.3
```
```
mariadb10.4
```
```
mariadb10.5
```
```
mariadb10.6
```
```
mysql5.7
```
```
mysql8.0
```
```
oracle-ee-19
```
```
oracle-ee-cdb-19
```
```
oracle-ee-cdb-21
```
```
oracle-se2-19
```
```
oracle-se2-cdb-19
```
```
oracle-se2-cdb-21
```
```
postgres10
```
```
postgres11
```
```
postgres12
```
```
postgres13
```
```
postgres14
```
```
sqlserver-ee-11.0
```
```
sqlserver-ee-12.0
```
```
sqlserver-ee-13.0
```
```
sqlserver-ee-14.0
```
```
sqlserver-ee-15.0
```
```
sqlserver-ex-11.0
```
```
sqlserver-ex-12.0
```
```
sqlserver-ex-13.0
```
```
sqlserver-ex-14.0
```
```
sqlserver-ex-15.0
```
```
sqlserver-se-11.0
```
```
sqlserver-se-12.0
```
```
sqlserver-se-13.0
```
```
sqlserver-se-14.0
```
```
sqlserver-se-15.0
```
```
sqlserver-web-11.0
```
```
sqlserver-web-12.0
```
```
sqlserver-web-13.0
```
```
sqlserver-web-14.0
```
```
sqlserver-web-15.0
```

Request Lenses

describeEngineDefaultParameters_filters :: Lens' DescribeEngineDefaultParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeEngineDefaultParameters_marker :: Lens' DescribeEngineDefaultParameters (Maybe Text) Source #

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeEngineDefaultParameters_maxRecords :: Lens' DescribeEngineDefaultParameters (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 called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeEngineDefaultParameters_dbParameterGroupFamily :: Lens' DescribeEngineDefaultParameters Text Source #

The name of the DB parameter group family.

Valid Values:

```
aurora5.6
```
```
aurora-mysql5.7
```
```
aurora-mysql8.0
```
```
aurora-postgresql10
```
```
aurora-postgresql11
```
```
aurora-postgresql12
```
```
aurora-postgresql13
```
```
aurora-postgresql14
```
```
custom-oracle-ee-19
```
```
mariadb10.2
```
```
mariadb10.3
```
```
mariadb10.4
```
```
mariadb10.5
```
```
mariadb10.6
```
```
mysql5.7
```
```
mysql8.0
```
```
oracle-ee-19
```
```
oracle-ee-cdb-19
```
```
oracle-ee-cdb-21
```
```
oracle-se2-19
```
```
oracle-se2-cdb-19
```
```
oracle-se2-cdb-21
```
```
postgres10
```
```
postgres11
```
```
postgres12
```
```
postgres13
```
```
postgres14
```
```
sqlserver-ee-11.0
```
```
sqlserver-ee-12.0
```
```
sqlserver-ee-13.0
```
```
sqlserver-ee-14.0
```
```
sqlserver-ee-15.0
```
```
sqlserver-ex-11.0
```
```
sqlserver-ex-12.0
```
```
sqlserver-ex-13.0
```
```
sqlserver-ex-14.0
```
```
sqlserver-ex-15.0
```
```
sqlserver-se-11.0
```
```
sqlserver-se-12.0
```
```
sqlserver-se-13.0
```
```
sqlserver-se-14.0
```
```
sqlserver-se-15.0
```
```
sqlserver-web-11.0
```
```
sqlserver-web-12.0
```
```
sqlserver-web-13.0
```
```
sqlserver-web-14.0
```
```
sqlserver-web-15.0
```

Destructuring the Response

data DescribeEngineDefaultParametersResponse Source #

See: newDescribeEngineDefaultParametersResponse smart constructor.

Constructors

DescribeEngineDefaultParametersResponse'
Fields httpStatus :: Int The response's http status code. engineDefaults :: EngineDefaults

Instances

Instances details

Generic DescribeEngineDefaultParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Associated Types type Rep DescribeEngineDefaultParametersResponse :: Type -> Type # Methods from :: DescribeEngineDefaultParametersResponse -> Rep DescribeEngineDefaultParametersResponse x # to :: Rep DescribeEngineDefaultParametersResponse x -> DescribeEngineDefaultParametersResponse #
Read DescribeEngineDefaultParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods readsPrec :: Int -> ReadS DescribeEngineDefaultParametersResponse # readList :: ReadS [DescribeEngineDefaultParametersResponse] # readPrec :: ReadPrec DescribeEngineDefaultParametersResponse # readListPrec :: ReadPrec [DescribeEngineDefaultParametersResponse] #
Show DescribeEngineDefaultParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods showsPrec :: Int -> DescribeEngineDefaultParametersResponse -> ShowS # show :: DescribeEngineDefaultParametersResponse -> String # showList :: [DescribeEngineDefaultParametersResponse] -> ShowS #
NFData DescribeEngineDefaultParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods rnf :: DescribeEngineDefaultParametersResponse -> () #
Eq DescribeEngineDefaultParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters Methods (==) :: DescribeEngineDefaultParametersResponse -> DescribeEngineDefaultParametersResponse -> Bool # (/=) :: DescribeEngineDefaultParametersResponse -> DescribeEngineDefaultParametersResponse -> Bool #
type Rep DescribeEngineDefaultParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeEngineDefaultParameters type Rep DescribeEngineDefaultParametersResponse = D1 ('MetaData "DescribeEngineDefaultParametersResponse" "Amazonka.RDS.DescribeEngineDefaultParameters" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeEngineDefaultParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "engineDefaults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EngineDefaults)))

newDescribeEngineDefaultParametersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEngineDefaultParametersResponse'`
-> EngineDefaults	`$sel:engineDefaults:DescribeEngineDefaultParametersResponse'`
-> DescribeEngineDefaultParametersResponse

Create a value of DescribeEngineDefaultParametersResponse 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:httpStatus:DescribeEngineDefaultParametersResponse', describeEngineDefaultParametersResponse_httpStatus - The response's http status code.

$sel:engineDefaults:DescribeEngineDefaultParametersResponse', describeEngineDefaultParametersResponse_engineDefaults - Undocumented member.

Response Lenses

describeEngineDefaultParametersResponse_httpStatus :: Lens' DescribeEngineDefaultParametersResponse Int Source #

The response's http status code.

describeEngineDefaultParametersResponse_engineDefaults :: Lens' DescribeEngineDefaultParametersResponse EngineDefaults Source #

Undocumented member.