amazonka-dynamodb-dax-1.5.0: Amazon DynamoDB Accelerator (DAX) SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DAX.DescribeParameters

Contents

Description

Returns the detailed parameter list for a particular parameter group.

Synopsis

Creating a Request

describeParameters Source #

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

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

  • dpNextToken - 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 .
  • dpSource - How the parameter is defined. For example, system denotes a system-defined parameter.
  • dpMaxResults - 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.
  • dpParameterGroupName - The name of the parameter group.

data DescribeParameters Source #

See: describeParameters smart constructor.

Instances

Eq DescribeParameters Source # 
Data DescribeParameters Source # 

Methods

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

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

toConstr :: DescribeParameters -> Constr #

dataTypeOf :: DescribeParameters -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeParameters -> DescribeParameters #

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

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

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

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

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

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

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

Read DescribeParameters Source # 
Show DescribeParameters Source # 
Generic DescribeParameters Source # 
Hashable DescribeParameters Source # 
ToJSON DescribeParameters Source # 
NFData DescribeParameters Source # 

Methods

rnf :: DescribeParameters -> () #

AWSRequest DescribeParameters Source # 
ToQuery DescribeParameters Source # 
ToPath DescribeParameters Source # 
ToHeaders DescribeParameters Source # 
type Rep DescribeParameters Source # 
type Rep DescribeParameters = D1 (MetaData "DescribeParameters" "Network.AWS.DAX.DescribeParameters" "amazonka-dynamodb-dax-1.5.0-JMry6GeWLPS2KkVhaaXmgc" False) (C1 (MetaCons "DescribeParameters'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dpSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_dpParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeParameters Source # 

Request Lenses

dpNextToken :: 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 .

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

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

dpMaxResults :: 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.

dpParameterGroupName :: Lens' DescribeParameters Text Source #

The name of the parameter group.

Destructuring the Response

describeParametersResponse Source #

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

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

  • dprsNextToken - Provides an identifier to allow retrieval of paginated results.
  • dprsParameters - A list of parameters within a parameter group. Each element in the list represents one parameter.
  • dprsResponseStatus - -- | The response status code.

data DescribeParametersResponse Source #

See: describeParametersResponse smart constructor.

Instances

Eq DescribeParametersResponse Source # 
Data DescribeParametersResponse Source # 

Methods

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

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

toConstr :: DescribeParametersResponse -> Constr #

dataTypeOf :: DescribeParametersResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeParametersResponse -> DescribeParametersResponse #

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

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

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

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

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

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

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

Read DescribeParametersResponse Source # 
Show DescribeParametersResponse Source # 
Generic DescribeParametersResponse Source # 
NFData DescribeParametersResponse Source # 
type Rep DescribeParametersResponse Source # 
type Rep DescribeParametersResponse = D1 (MetaData "DescribeParametersResponse" "Network.AWS.DAX.DescribeParameters" "amazonka-dynamodb-dax-1.5.0-JMry6GeWLPS2KkVhaaXmgc" False) (C1 (MetaCons "DescribeParametersResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dprsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))) (S1 (MetaSel (Just Symbol "_dprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

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

Provides an identifier to allow retrieval of paginated results.

dprsParameters :: Lens' DescribeParametersResponse [Parameter] Source #

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