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.RDS.DescribeDBParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the detailed parameter list for a particular DB parameter group.

This operation returns paginated results.

Synopsis

data DescribeDBParameters = DescribeDBParameters' {
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
- source :: Maybe Text
- dbParameterGroupName :: Text
}
newDescribeDBParameters :: Text -> DescribeDBParameters
describeDBParameters_filters :: Lens' DescribeDBParameters (Maybe [Filter])
describeDBParameters_marker :: Lens' DescribeDBParameters (Maybe Text)
describeDBParameters_maxRecords :: Lens' DescribeDBParameters (Maybe Int)
describeDBParameters_source :: Lens' DescribeDBParameters (Maybe Text)
describeDBParameters_dbParameterGroupName :: Lens' DescribeDBParameters Text
data DescribeDBParametersResponse = DescribeDBParametersResponse' {
- marker :: Maybe Text
- parameters :: Maybe [Parameter]
- httpStatus :: Int
}
newDescribeDBParametersResponse :: Int -> DescribeDBParametersResponse
describeDBParametersResponse_marker :: Lens' DescribeDBParametersResponse (Maybe Text)
describeDBParametersResponse_parameters :: Lens' DescribeDBParametersResponse (Maybe [Parameter])
describeDBParametersResponse_httpStatus :: Lens' DescribeDBParametersResponse Int

Creating a Request

data DescribeDBParameters Source #

See: newDescribeDBParameters smart constructor.

Constructors

DescribeDBParameters'

Fields

filters :: Maybe [Filter]
This parameter isn't currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeDBParameters 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 that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
source :: Maybe Text
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
dbParameterGroupName :: Text
The name of a specific DB parameter group to return details for.
Constraints:
- If supplied, must match the name of an existing DBParameterGroup.

Instances

Instances details

Eq DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods (==) :: DescribeDBParameters -> DescribeDBParameters -> Bool # (/=) :: DescribeDBParameters -> DescribeDBParameters -> Bool #
Read DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods readsPrec :: Int -> ReadS DescribeDBParameters # readList :: ReadS [DescribeDBParameters] # readPrec :: ReadPrec DescribeDBParameters # readListPrec :: ReadPrec [DescribeDBParameters] #
Show DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods showsPrec :: Int -> DescribeDBParameters -> ShowS # show :: DescribeDBParameters -> String # showList :: [DescribeDBParameters] -> ShowS #
Generic DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Associated Types type Rep DescribeDBParameters :: Type -> Type # Methods from :: DescribeDBParameters -> Rep DescribeDBParameters x # to :: Rep DescribeDBParameters x -> DescribeDBParameters #
NFData DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods rnf :: DescribeDBParameters -> () #
Hashable DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods hashWithSalt :: Int -> DescribeDBParameters -> Int # hash :: DescribeDBParameters -> Int #
AWSPager DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods page :: DescribeDBParameters -> AWSResponse DescribeDBParameters -> Maybe DescribeDBParameters #
AWSRequest DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Associated Types type AWSResponse DescribeDBParameters # Methods request :: DescribeDBParameters -> Request DescribeDBParameters # response :: MonadResource m => Logger -> Service -> Proxy DescribeDBParameters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBParameters))) #
ToHeaders DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods toHeaders :: DescribeDBParameters -> [Header] #
ToPath DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods toPath :: DescribeDBParameters -> ByteString #
ToQuery DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods toQuery :: DescribeDBParameters -> QueryString #
type Rep DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters type Rep DescribeDBParameters = D1 ('MetaData "DescribeDBParameters" "Amazonka.RDS.DescribeDBParameters" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBParameters'" '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 "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeDBParameters Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters type AWSResponse DescribeDBParameters = DescribeDBParametersResponse

newDescribeDBParameters Source #

Arguments

:: Text	`$sel:dbParameterGroupName:DescribeDBParameters'`
-> DescribeDBParameters

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

$sel:marker:DescribeDBParameters', describeDBParameters_marker - An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeDBParameters', describeDBParameters_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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

$sel:source:DescribeDBParameters', describeDBParameters_source - The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

$sel:dbParameterGroupName:DescribeDBParameters', describeDBParameters_dbParameterGroupName - The name of a specific DB parameter group to return details for.

Constraints:

If supplied, must match the name of an existing DBParameterGroup.

Request Lenses

describeDBParameters_filters :: Lens' DescribeDBParameters (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBParameters_marker :: Lens' DescribeDBParameters (Maybe Text) Source #

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

describeDBParameters_maxRecords :: Lens' DescribeDBParameters (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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBParameters_source :: Lens' DescribeDBParameters (Maybe Text) Source #

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

describeDBParameters_dbParameterGroupName :: Lens' DescribeDBParameters Text Source #

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

Constraints:

If supplied, must match the name of an existing DBParameterGroup.

Destructuring the Response

data DescribeDBParametersResponse Source #

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

See: newDescribeDBParametersResponse smart constructor.

Constructors

DescribeDBParametersResponse'
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`. parameters :: Maybe [Parameter] A list of `Parameter` values. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeDBParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods (==) :: DescribeDBParametersResponse -> DescribeDBParametersResponse -> Bool # (/=) :: DescribeDBParametersResponse -> DescribeDBParametersResponse -> Bool #
Read DescribeDBParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods readsPrec :: Int -> ReadS DescribeDBParametersResponse # readList :: ReadS [DescribeDBParametersResponse] # readPrec :: ReadPrec DescribeDBParametersResponse # readListPrec :: ReadPrec [DescribeDBParametersResponse] #
Show DescribeDBParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods showsPrec :: Int -> DescribeDBParametersResponse -> ShowS # show :: DescribeDBParametersResponse -> String # showList :: [DescribeDBParametersResponse] -> ShowS #
Generic DescribeDBParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Associated Types type Rep DescribeDBParametersResponse :: Type -> Type # Methods from :: DescribeDBParametersResponse -> Rep DescribeDBParametersResponse x # to :: Rep DescribeDBParametersResponse x -> DescribeDBParametersResponse #
NFData DescribeDBParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters Methods rnf :: DescribeDBParametersResponse -> () #
type Rep DescribeDBParametersResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBParameters type Rep DescribeDBParametersResponse = D1 ('MetaData "DescribeDBParametersResponse" "Amazonka.RDS.DescribeDBParameters" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBParametersResponse Source #

Arguments

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

Create a value of DescribeDBParametersResponse 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:DescribeDBParameters', describeDBParametersResponse_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:parameters:DescribeDBParametersResponse', describeDBParametersResponse_parameters - A list of Parameter values.

$sel:httpStatus:DescribeDBParametersResponse', describeDBParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeDBParametersResponse_marker :: Lens' DescribeDBParametersResponse (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.

describeDBParametersResponse_parameters :: Lens' DescribeDBParametersResponse (Maybe [Parameter]) Source #

A list of Parameter values.

describeDBParametersResponse_httpStatus :: Lens' DescribeDBParametersResponse Int Source #

The response's http status code.