/AWS1/CL_SSM=>GETPARAMETERSBYPATH()
¶
About GetParametersByPath¶
Retrieve information about one or more parameters in a specific hierarchy.
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_PATH
TYPE /AWS1/SSMPSPARAMETERNAME
/AWS1/SSMPSPARAMETERNAME
¶
The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33
Optional arguments:¶
IV_RECURSIVE
TYPE /AWS1/SSMBOOLEAN
/AWS1/SSMBOOLEAN
¶
Retrieve all parameters within a hierarchy.
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/a/b
. Even if a user has explicitly been denied access in IAM for parameter/a/b
, they can still call the GetParametersByPath API operation recursively for/a
and view/a/b
.
IT_PARAMETERFILTERS
TYPE /AWS1/CL_SSMPARAMSTRINGFILTER=>TT_PARAMETERSTRINGFILTERLIST
TT_PARAMETERSTRINGFILTERLIST
¶
Filters to limit the request results.
The following
Key
values are supported forGetParametersByPath
:Type
,KeyId
, andLabel
.The following
Key
values aren't supported forGetParametersByPath
:tag
,DataType
,Name
,Path
, andTier
.
IV_WITHDECRYPTION
TYPE /AWS1/SSMBOOLEAN
/AWS1/SSMBOOLEAN
¶
Retrieve all parameters in a hierarchy with their value decrypted.
IV_MAXRESULTS
TYPE /AWS1/SSMGETPARMSBYPATHMAXRSS
/AWS1/SSMGETPARMSBYPATHMAXRSS
¶
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.
IV_NEXTTOKEN
TYPE /AWS1/SSMNEXTTOKEN
/AWS1/SSMNEXTTOKEN
¶
A token to start the list. Use this token to get the next set of results.