Network.AWS.RDS.DescribeDBParameters

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

This operation returns paginated results.

Creating a Request

describeDBParameters

Arguments

:: Text

ddpDBParameterGroupName

-> DescribeDBParameters

Creates a value of DescribeDBParameters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddpFilters - This parameter is not currently supported.
• ddpMarker - 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 .
• ddpMaxRecords - 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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
• ddpSource - The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default
• ddpDBParameterGroupName - The name of a specific DB parameter group to return details for. Constraints: * Must be 1 to 255 alphanumeric characters * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

data DescribeDBParameters

See: describeDBParameters smart constructor.

Instances

Eq DescribeDBParameters

Methods

(==) :: DescribeDBParameters -> DescribeDBParameters -> Bool

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

Data DescribeDBParameters

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBParameters -> c DescribeDBParameters

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBParameters

toConstr :: DescribeDBParameters -> Constr

dataTypeOf :: DescribeDBParameters -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBParameters)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBParameters)

gmapT :: (forall b. Data b => b -> b) -> DescribeDBParameters -> DescribeDBParameters

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBParameters -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBParameters -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDBParameters -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBParameters -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBParameters -> m DescribeDBParameters

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBParameters -> m DescribeDBParameters

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBParameters -> m DescribeDBParameters

Read DescribeDBParameters

Methods

readsPrec :: Int -> ReadS DescribeDBParameters

readList :: ReadS [DescribeDBParameters]

readPrec :: ReadPrec DescribeDBParameters

readListPrec :: ReadPrec [DescribeDBParameters]

Show DescribeDBParameters

Methods

showsPrec :: Int -> DescribeDBParameters -> ShowS

show :: DescribeDBParameters -> String

showList :: [DescribeDBParameters] -> ShowS

Generic DescribeDBParameters

Associated Types

type Rep DescribeDBParameters :: * -> *

Methods

from :: DescribeDBParameters -> Rep DescribeDBParameters x

to :: Rep DescribeDBParameters x -> DescribeDBParameters

Hashable DescribeDBParameters

Methods

hashWithSalt :: Int -> DescribeDBParameters -> Int

hash :: DescribeDBParameters -> Int

NFData DescribeDBParameters

Methods

rnf :: DescribeDBParameters -> ()

AWSPager DescribeDBParameters

Methods

page :: DescribeDBParameters -> Rs DescribeDBParameters -> Maybe DescribeDBParameters

AWSRequest DescribeDBParameters

Associated Types

type Rs DescribeDBParameters :: *

Methods

request :: DescribeDBParameters -> Request DescribeDBParameters

response :: MonadResource m => Logger -> Service -> Proxy * DescribeDBParameters -> ClientResponse -> m (Response DescribeDBParameters)

ToPath DescribeDBParameters

Methods

toPath :: DescribeDBParameters -> ByteString

ToHeaders DescribeDBParameters

Methods

toHeaders :: DescribeDBParameters -> [Header]

ToQuery DescribeDBParameters

Methods

toQuery :: DescribeDBParameters -> QueryString

type Rep DescribeDBParameters

type Rep DescribeDBParameters = D1 (MetaData "DescribeDBParameters" "Network.AWS.RDS.DescribeDBParameters" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBParameters'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ddpFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Filter]))) (S1 (MetaSel (Just Symbol "_ddpMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ddpMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_ddpSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ddpDBParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs DescribeDBParameters

type Rs DescribeDBParameters = DescribeDBParametersResponse

Request Lenses

ddpFilters :: Lens' DescribeDBParameters [Filter]

This parameter is not currently supported.

ddpMarker :: Lens' DescribeDBParameters (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 .

ddpMaxRecords :: Lens' DescribeDBParameters (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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

ddpSource :: Lens' DescribeDBParameters (Maybe Text)

The parameter types to return. Default: All parameter types returned Valid Values: user | system | engine-default

ddpDBParameterGroupName :: Lens' DescribeDBParameters Text

The name of a specific DB parameter group to return details for. Constraints: * Must be 1 to 255 alphanumeric characters * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

Destructuring the Response

describeDBParametersResponse

Arguments

:: Int

ddprsResponseStatus

-> DescribeDBParametersResponse

Creates a value of DescribeDBParametersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddprsMarker - 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 .
• ddprsParameters - A list of Parameter values.
• ddprsResponseStatus - -- | The response status code.

data DescribeDBParametersResponse

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

See: describeDBParametersResponse smart constructor.

Instances

Eq DescribeDBParametersResponse

Methods

(==) :: DescribeDBParametersResponse -> DescribeDBParametersResponse -> Bool

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

Data DescribeDBParametersResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeDBParametersResponse -> c DescribeDBParametersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeDBParametersResponse

toConstr :: DescribeDBParametersResponse -> Constr

dataTypeOf :: DescribeDBParametersResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeDBParametersResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeDBParametersResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeDBParametersResponse -> DescribeDBParametersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBParametersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeDBParametersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeDBParametersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeDBParametersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeDBParametersResponse -> m DescribeDBParametersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBParametersResponse -> m DescribeDBParametersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeDBParametersResponse -> m DescribeDBParametersResponse

Read DescribeDBParametersResponse

Methods

readsPrec :: Int -> ReadS DescribeDBParametersResponse

readList :: ReadS [DescribeDBParametersResponse]

readPrec :: ReadPrec DescribeDBParametersResponse

readListPrec :: ReadPrec [DescribeDBParametersResponse]

Show DescribeDBParametersResponse

Methods

showsPrec :: Int -> DescribeDBParametersResponse -> ShowS

show :: DescribeDBParametersResponse -> String

showList :: [DescribeDBParametersResponse] -> ShowS

Generic DescribeDBParametersResponse

Associated Types

type Rep DescribeDBParametersResponse :: * -> *

Methods

from :: DescribeDBParametersResponse -> Rep DescribeDBParametersResponse x

to :: Rep DescribeDBParametersResponse x -> DescribeDBParametersResponse

NFData DescribeDBParametersResponse

Methods

rnf :: DescribeDBParametersResponse -> ()

type Rep DescribeDBParametersResponse

type Rep DescribeDBParametersResponse = D1 (MetaData "DescribeDBParametersResponse" "Network.AWS.RDS.DescribeDBParameters" "amazonka-rds-1.4.5-FycntHHvABz6gJkK2IrBDo" False) (C1 (MetaCons "DescribeDBParametersResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ddprsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ddprsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))) (S1 (MetaSel (Just Symbol "_ddprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

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

ddprsParameters :: Lens' DescribeDBParametersResponse [Parameter]

A list of Parameter values.

ddprsResponseStatus :: Lens' DescribeDBParametersResponse Int

• - | The response status code.