Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.
ssm_get_parameters_by_path(Path, Recursive, ParameterFilters,
WithDecryption, MaxResults, NextToken)[required] The hierarchy for the parameter. Hierarchies start with a forward slash
(/) and end with the parameter name. A parameter name hierarchy can have
a maximum of 15 levels. Here is an example of a hierarchy:
/Finance/Prod/IAD/WinServ2016/license33
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, they can still call the GetParametersByPath API action recursively and view /a/b.
Filters to limit the request results.
You can't filter using the parameter name.
Retrieve all parameters in a hierarchy with their value decrypted.
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.
A token to start the list. Use this token to get the next set of results.
svc$get_parameters_by_path(
Path = "string",
Recursive = TRUE|FALSE,
ParameterFilters = list(
list(
Key = "string",
Option = "string",
Values = list(
"string"
)
)
),
WithDecryption = TRUE|FALSE,
MaxResults = 123,
NextToken = "string"
)
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 API action doesn't support filtering by tags.