amazonka-ssm-1.6.1: Amazon Simple Systems Manager (SSM) SDK.

Copyright(c) 2013-2018 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.SSM.DescribeParameters

Contents

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.

Synopsis

Creating a Request

describeParameters :: 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:

  • 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 Source #

See: describeParameters smart constructor.

Instances
Eq DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Data DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.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 Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Show DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Generic DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Associated Types

type Rep DescribeParameters :: Type -> Type #

Hashable DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

ToJSON DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

AWSPager DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

AWSRequest DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Associated Types

type Rs DescribeParameters :: Type #

ToHeaders DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

ToPath DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

ToQuery DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

NFData DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Methods

rnf :: DescribeParameters -> () #

type Rep DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

type Rep DescribeParameters = D1 (MetaData "DescribeParameters" "Network.AWS.SSM.DescribeParameters" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "DescribeParameters'" PrefixI True) ((S1 (MetaSel (Just "_dpParameterFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParameterStringFilter])) :*: S1 (MetaSel (Just "_dpFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParametersFilter]))) :*: (S1 (MetaSel (Just "_dpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))
type Rs DescribeParameters Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Request Lenses

dpParameterFilters :: Lens' DescribeParameters [ParameterStringFilter] Source #

Filters to limit the request results.

dpFilters :: Lens' DescribeParameters [ParametersFilter] Source #

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

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

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

dpMaxResults :: Lens' DescribeParameters (Maybe Natural) Source #

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 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 - 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 Source #

See: describeParametersResponse smart constructor.

Instances
Eq DescribeParametersResponse Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Data DescribeParametersResponse Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

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 # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Show DescribeParametersResponse Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Generic DescribeParametersResponse Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

Associated Types

type Rep DescribeParametersResponse :: Type -> Type #

NFData DescribeParametersResponse Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

type Rep DescribeParametersResponse Source # 
Instance details

Defined in Network.AWS.SSM.DescribeParameters

type Rep DescribeParametersResponse = D1 (MetaData "DescribeParametersResponse" "Network.AWS.SSM.DescribeParameters" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "DescribeParametersResponse'" PrefixI True) (S1 (MetaSel (Just "_dprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dprsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParameterMetadata])) :*: S1 (MetaSel (Just "_dprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

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

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