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.DAX.DescribeParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the detailed parameter list for a particular parameter group.

This operation returns paginated results.

Synopsis

data DescribeParameters = DescribeParameters' {
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- source :: Maybe Text
- parameterGroupName :: Text
}
newDescribeParameters :: Text -> DescribeParameters
describeParameters_maxResults :: Lens' DescribeParameters (Maybe Int)
describeParameters_nextToken :: Lens' DescribeParameters (Maybe Text)
describeParameters_source :: Lens' DescribeParameters (Maybe Text)
describeParameters_parameterGroupName :: Lens' DescribeParameters Text
data DescribeParametersResponse = DescribeParametersResponse' {
- nextToken :: Maybe Text
- parameters :: Maybe [Parameter]
- httpStatus :: Int
}
newDescribeParametersResponse :: Int -> DescribeParametersResponse
describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (Maybe Text)
describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [Parameter])
describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int

Creating a Request

data DescribeParameters Source #

See: newDescribeParameters smart constructor.

Constructors

DescribeParameters'

Fields

maxResults :: Maybe Int
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.
nextToken :: Maybe Text
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
source :: Maybe Text
How the parameter is defined. For example, system denotes a system-defined parameter.
parameterGroupName :: Text
The name of the parameter group.

Instances

Instances details

ToJSON DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods toJSON :: DescribeParameters -> Value # toEncoding :: DescribeParameters -> Encoding # toJSONList :: [DescribeParameters] -> Value # toEncodingList :: [DescribeParameters] -> Encoding #
ToHeaders DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods toHeaders :: DescribeParameters -> [Header] #
ToPath DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods toPath :: DescribeParameters -> ByteString #
ToQuery DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods toQuery :: DescribeParameters -> QueryString #
AWSPager DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods page :: DescribeParameters -> AWSResponse DescribeParameters -> Maybe DescribeParameters #
AWSRequest DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Associated Types type AWSResponse DescribeParameters # Methods request :: (Service -> Service) -> DescribeParameters -> Request DescribeParameters # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeParameters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeParameters))) #
Generic DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Associated Types type Rep DescribeParameters :: Type -> Type # Methods from :: DescribeParameters -> Rep DescribeParameters x # to :: Rep DescribeParameters x -> DescribeParameters #
Read DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods readsPrec :: Int -> ReadS DescribeParameters # readList :: ReadS [DescribeParameters] # readPrec :: ReadPrec DescribeParameters # readListPrec :: ReadPrec [DescribeParameters] #
Show DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods showsPrec :: Int -> DescribeParameters -> ShowS # show :: DescribeParameters -> String # showList :: [DescribeParameters] -> ShowS #
NFData DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods rnf :: DescribeParameters -> () #
Eq DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods (==) :: DescribeParameters -> DescribeParameters -> Bool # (/=) :: DescribeParameters -> DescribeParameters -> Bool #
Hashable DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods hashWithSalt :: Int -> DescribeParameters -> Int # hash :: DescribeParameters -> Int #
type AWSResponse DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters type AWSResponse DescribeParameters = DescribeParametersResponse
type Rep DescribeParameters Source #
Instance details Defined in Amazonka.DAX.DescribeParameters type Rep DescribeParameters = D1 ('MetaData "DescribeParameters" "Amazonka.DAX.DescribeParameters" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "DescribeParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeParameters Source #

Arguments

:: Text	`DescribeParameters`
-> DescribeParameters

Create a value of DescribeParameters 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:maxResults:DescribeParameters', describeParameters_maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

DescribeParameters, describeParameters_nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

DescribeParameters, describeParameters_source - How the parameter is defined. For example, system denotes a system-defined parameter.

DescribeParameters, describeParameters_parameterGroupName - The name of the parameter group.

Request Lenses

describeParameters_maxResults :: Lens' DescribeParameters (Maybe Int) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

describeParameters_nextToken :: Lens' DescribeParameters (Maybe Text) Source #

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

describeParameters_source :: Lens' DescribeParameters (Maybe Text) Source #

How the parameter is defined. For example, system denotes a system-defined parameter.

describeParameters_parameterGroupName :: Lens' DescribeParameters Text Source #

The name of the parameter group.

Destructuring the Response

data DescribeParametersResponse Source #

See: newDescribeParametersResponse smart constructor.

Constructors

DescribeParametersResponse'
Fields nextToken :: Maybe Text Provides an identifier to allow retrieval of paginated results. parameters :: Maybe [Parameter] A list of parameters within a parameter group. Each element in the list represents one parameter. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeParametersResponse Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Associated Types type Rep DescribeParametersResponse :: Type -> Type # Methods from :: DescribeParametersResponse -> Rep DescribeParametersResponse x # to :: Rep DescribeParametersResponse x -> DescribeParametersResponse #
Read DescribeParametersResponse Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods readsPrec :: Int -> ReadS DescribeParametersResponse # readList :: ReadS [DescribeParametersResponse] # readPrec :: ReadPrec DescribeParametersResponse # readListPrec :: ReadPrec [DescribeParametersResponse] #
Show DescribeParametersResponse Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods showsPrec :: Int -> DescribeParametersResponse -> ShowS # show :: DescribeParametersResponse -> String # showList :: [DescribeParametersResponse] -> ShowS #
NFData DescribeParametersResponse Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods rnf :: DescribeParametersResponse -> () #
Eq DescribeParametersResponse Source #
Instance details Defined in Amazonka.DAX.DescribeParameters Methods (==) :: DescribeParametersResponse -> DescribeParametersResponse -> Bool # (/=) :: DescribeParametersResponse -> DescribeParametersResponse -> Bool #
type Rep DescribeParametersResponse Source #
Instance details Defined in Amazonka.DAX.DescribeParameters type Rep DescribeParametersResponse = D1 ('MetaData "DescribeParametersResponse" "Amazonka.DAX.DescribeParameters" "amazonka-dynamodb-dax-2.0-FwsdPL1z9NS2dTys8oHQ2n" 'False) (C1 ('MetaCons "DescribeParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") '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))))

newDescribeParametersResponse Source #

Arguments

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

Create a value of DescribeParametersResponse 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:

DescribeParameters, describeParametersResponse_nextToken - Provides an identifier to allow retrieval of paginated results.

$sel:parameters:DescribeParametersResponse', describeParametersResponse_parameters - A list of parameters within a parameter group. Each element in the list represents one parameter.

$sel:httpStatus:DescribeParametersResponse', describeParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [Parameter]) Source #

A list of parameters within a parameter group. Each element in the list represents one parameter.

describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int Source #

The response's http status code.