Retrieve information about one or more parameters under a specified level in a hierarchy.
This operation is authorized against the ssm:GetParametersByPath action for the path that you specify in the request. It isn't authorized against the individual parameters that it returns, and it isn't authorized against ssm:GetParameter. A principal who is allowed to call this operation for the path /a with Recursive set to true receives every parameter under that path, including /a/b, even if a policy explicitly denies access to /a/b. To prevent a parameter from being returned by this operation, deny the ssm:GetParametersByPath action on every ancestor path that could include the parameter in its results. For more information, see Restricting access to specific parameters and paths in the Amazon Web Services Systems Manager User Guide. 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.
Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a
ValidationException error.
This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.