Network.AWS.SSM.GetParametersByPath

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters .

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

getParametersByPath

Arguments

:: Text

gpbpPath

-> GetParametersByPath

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

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

• gpbpWithDecryption - Retrieve all parameters in a hierarchy with their value decrypted.
• gpbpParameterFilters - Filters to limit the request results.
• gpbpNextToken - A token to start the list. Use this token to get the next set of results.
• gpbpRecursive - Retrieve all parameters within a hierarchy. Important: If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path a, then the user can also access ab. Even if a user has explicitly been denied access in IAM for parameter a, they can still call the GetParametersByPath API action recursively and view ab.
• gpbpMaxResults - 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.
• gpbpPath - The hierarchy for the parameter. Hierarchies start with a forward slash () and end with the parameter name. A hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: @FinanceProdIADWinServ2016license33@

data GetParametersByPath

See: getParametersByPath smart constructor.

Instances

Eq GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

(==) :: GetParametersByPath -> GetParametersByPath -> Bool

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

Data GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

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

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

toConstr :: GetParametersByPath -> Constr

dataTypeOf :: GetParametersByPath -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

readsPrec :: Int -> ReadS GetParametersByPath

readList :: ReadS [GetParametersByPath]

readPrec :: ReadPrec GetParametersByPath

readListPrec :: ReadPrec [GetParametersByPath]

Show GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

showsPrec :: Int -> GetParametersByPath -> ShowS

show :: GetParametersByPath -> String

showList :: [GetParametersByPath] -> ShowS

Generic GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Associated Types

type Rep GetParametersByPath :: Type -> Type

Methods

from :: GetParametersByPath -> Rep GetParametersByPath x

to :: Rep GetParametersByPath x -> GetParametersByPath

Hashable GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

hashWithSalt :: Int -> GetParametersByPath -> Int

hash :: GetParametersByPath -> Int

ToJSON GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

toJSON :: GetParametersByPath -> Value

toEncoding :: GetParametersByPath -> Encoding

toJSONList :: [GetParametersByPath] -> Value

toEncodingList :: [GetParametersByPath] -> Encoding

AWSPager GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

page :: GetParametersByPath -> Rs GetParametersByPath -> Maybe GetParametersByPath

AWSRequest GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Associated Types

type Rs GetParametersByPath :: Type

Methods

request :: GetParametersByPath -> Request GetParametersByPath

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetParametersByPath -> ClientResponse -> m (Response GetParametersByPath)

ToHeaders GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

toHeaders :: GetParametersByPath -> [Header]

ToPath GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

toPath :: GetParametersByPath -> ByteString

ToQuery GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

toQuery :: GetParametersByPath -> QueryString

NFData GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

Methods

rnf :: GetParametersByPath -> ()

type Rep GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

type Rep GetParametersByPath = D1 (MetaData "GetParametersByPath" "Network.AWS.SSM.GetParametersByPath" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "GetParametersByPath'" PrefixI True) ((S1 (MetaSel (Just "_gpbpWithDecryption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_gpbpParameterFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ParameterStringFilter])) :*: S1 (MetaSel (Just "_gpbpNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_gpbpRecursive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_gpbpMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_gpbpPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetParametersByPath

Defined in Network.AWS.SSM.GetParametersByPath

type Rs GetParametersByPath = GetParametersByPathResponse

Request Lenses

gpbpWithDecryption :: Lens' GetParametersByPath (Maybe Bool)

Retrieve all parameters in a hierarchy with their value decrypted.

gpbpParameterFilters :: Lens' GetParametersByPath [ParameterStringFilter]

Filters to limit the request results.

gpbpNextToken :: Lens' GetParametersByPath (Maybe Text)

A token to start the list. Use this token to get the next set of results.

gpbpRecursive :: Lens' GetParametersByPath (Maybe Bool)

Retrieve all parameters within a hierarchy. Important: If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path a, then the user can also access ab. Even if a user has explicitly been denied access in IAM for parameter a, they can still call the GetParametersByPath API action recursively and view ab.

gpbpMaxResults :: Lens' GetParametersByPath (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.

gpbpPath :: Lens' GetParametersByPath Text

The hierarchy for the parameter. Hierarchies start with a forward slash () and end with the parameter name. A hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: @FinanceProdIADWinServ2016license33@

Destructuring the Response

getParametersByPathResponse

Arguments

:: Int

gpbprsResponseStatus

-> GetParametersByPathResponse

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

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

• gpbprsNextToken - The token for the next set of items to return. Use this token to get the next set of results.
• gpbprsParameters - A list of parameters found in the specified hierarchy.
• gpbprsResponseStatus - -- | The response status code.

data GetParametersByPathResponse

See: getParametersByPathResponse smart constructor.

Instances

Eq GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

Methods

(==) :: GetParametersByPathResponse -> GetParametersByPathResponse -> Bool

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

Data GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

Methods

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

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

toConstr :: GetParametersByPathResponse -> Constr

dataTypeOf :: GetParametersByPathResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

Methods

readsPrec :: Int -> ReadS GetParametersByPathResponse

readList :: ReadS [GetParametersByPathResponse]

readPrec :: ReadPrec GetParametersByPathResponse

readListPrec :: ReadPrec [GetParametersByPathResponse]

Show GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

Methods

showsPrec :: Int -> GetParametersByPathResponse -> ShowS

show :: GetParametersByPathResponse -> String

showList :: [GetParametersByPathResponse] -> ShowS

Generic GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

Associated Types

type Rep GetParametersByPathResponse :: Type -> Type

Methods

from :: GetParametersByPathResponse -> Rep GetParametersByPathResponse x

to :: Rep GetParametersByPathResponse x -> GetParametersByPathResponse

NFData GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

Methods

rnf :: GetParametersByPathResponse -> ()

type Rep GetParametersByPathResponse

Defined in Network.AWS.SSM.GetParametersByPath

type Rep GetParametersByPathResponse = D1 (MetaData "GetParametersByPathResponse" "Network.AWS.SSM.GetParametersByPath" "amazonka-ssm-1.6.1-7PbnocxNW5qAr7pEvzAy6Q" False) (C1 (MetaCons "GetParametersByPathResponse'" PrefixI True) (S1 (MetaSel (Just "_gpbprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_gpbprsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter])) :*: S1 (MetaSel (Just "_gpbprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gpbprsNextToken :: Lens' GetParametersByPathResponse (Maybe Text)

The token for the next set of items to return. Use this token to get the next set of results.

gpbprsParameters :: Lens' GetParametersByPathResponse [Parameter]

A list of parameters found in the specified hierarchy.

gpbprsResponseStatus :: Lens' GetParametersByPathResponse Int

• - | The response status code.