Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.SSM.DescribeParameters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults . If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken . You can specify the NextToken in a subsequent call to get the next set of results.

This operation returns paginated results.

Creating a Request

describeParameters :: DescribeParameters #

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:

dpParameterFilters - Filters to limit the request results.
dpFilters - One or more filters. Use a filter to return a more specific list of results.
dpNextToken - The token for the next set of items to return. (You received this token from a previous call.)
dpMaxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

data DescribeParameters #

See: describeParameters smart constructor.

Instances

Eq DescribeParameters #
Methods (==) :: DescribeParameters -> DescribeParameters -> Bool # (/=) :: DescribeParameters -> DescribeParameters -> Bool #
Data DescribeParameters #
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 #
Methods readsPrec :: Int -> ReadS DescribeParameters # readList :: ReadS [DescribeParameters] # readPrec :: ReadPrec DescribeParameters # readListPrec :: ReadPrec [DescribeParameters] #
Show DescribeParameters #
Methods showsPrec :: Int -> DescribeParameters -> ShowS # show :: DescribeParameters -> String # showList :: [DescribeParameters] -> ShowS #
Generic DescribeParameters #
Associated Types type Rep DescribeParameters :: * -> * # Methods from :: DescribeParameters -> Rep DescribeParameters x # to :: Rep DescribeParameters x -> DescribeParameters #
Hashable DescribeParameters #
Methods hashWithSalt :: Int -> DescribeParameters -> Int # hash :: DescribeParameters -> Int #
ToJSON DescribeParameters #
Methods toJSON :: DescribeParameters -> Value # toEncoding :: DescribeParameters -> Encoding # toJSONList :: [DescribeParameters] -> Value # toEncodingList :: [DescribeParameters] -> Encoding #
NFData DescribeParameters #
Methods rnf :: DescribeParameters -> () #
AWSPager DescribeParameters #
Methods page :: DescribeParameters -> Rs DescribeParameters -> Maybe DescribeParameters #
AWSRequest DescribeParameters #
Associated Types type Rs DescribeParameters :: * # Methods request :: DescribeParameters -> Request DescribeParameters # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeParameters -> ClientResponse -> m (Response DescribeParameters) #
ToHeaders DescribeParameters #
Methods toHeaders :: DescribeParameters -> [Header] #
ToPath DescribeParameters #
Methods toPath :: DescribeParameters -> ByteString #
ToQuery DescribeParameters #
Methods toQuery :: DescribeParameters -> QueryString #
type Rep DescribeParameters #
type Rep DescribeParameters = D1 * (MetaData "DescribeParameters" "Network.AWS.SSM.DescribeParameters" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" False) (C1 * (MetaCons "DescribeParameters'" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "_dpParameterFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ParameterStringFilter]))) (S1 * (MetaSel (Just Symbol "_dpFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ParametersFilter])))) ((::) (S1 * (MetaSel (Just Symbol "_dpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))
type Rs DescribeParameters #
type Rs DescribeParameters = DescribeParametersResponse

Request Lenses

dpParameterFilters :: Lens' DescribeParameters [ParameterStringFilter] #

Filters to limit the request results.

dpFilters :: Lens' DescribeParameters [ParametersFilter] #

One or more filters. Use a filter to return a more specific list of results.

dpNextToken :: Lens' DescribeParameters (Maybe Text) #

The token for the next set of items to return. (You received this token from a previous call.)

dpMaxResults :: Lens' DescribeParameters (Maybe Natural) #

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Destructuring the Response

describeParametersResponse #

Arguments

:: Int	`dprsResponseStatus`
-> DescribeParametersResponse

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 - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
dprsParameters - Parameters returned by the request.
dprsResponseStatus - -- | The response status code.

data DescribeParametersResponse #

See: describeParametersResponse smart constructor.

Instances

Eq DescribeParametersResponse #
Methods (==) :: DescribeParametersResponse -> DescribeParametersResponse -> Bool # (/=) :: DescribeParametersResponse -> DescribeParametersResponse -> Bool #
Data DescribeParametersResponse #
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 #
Methods readsPrec :: Int -> ReadS DescribeParametersResponse # readList :: ReadS [DescribeParametersResponse] # readPrec :: ReadPrec DescribeParametersResponse # readListPrec :: ReadPrec [DescribeParametersResponse] #
Show DescribeParametersResponse #
Methods showsPrec :: Int -> DescribeParametersResponse -> ShowS # show :: DescribeParametersResponse -> String # showList :: [DescribeParametersResponse] -> ShowS #
Generic DescribeParametersResponse #
Associated Types type Rep DescribeParametersResponse :: * -> * # Methods from :: DescribeParametersResponse -> Rep DescribeParametersResponse x # to :: Rep DescribeParametersResponse x -> DescribeParametersResponse #
NFData DescribeParametersResponse #
Methods rnf :: DescribeParametersResponse -> () #
type Rep DescribeParametersResponse #
type Rep DescribeParametersResponse = D1 * (MetaData "DescribeParametersResponse" "Network.AWS.SSM.DescribeParameters" "amazonka-ssm-1.6.0-3Tt35jiaR0xLZVuK0jt4Pc" 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 [ParameterMetadata]))) (S1 * (MetaSel (Just Symbol "_dprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dprsNextToken :: Lens' DescribeParametersResponse (Maybe Text) #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

dprsParameters :: Lens' DescribeParametersResponse [ParameterMetadata] #

Parameters returned by the request.

dprsResponseStatus :: Lens' DescribeParametersResponse Int #

- | The response status code.