Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]



Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS 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.


This API action doesn't support filtering by tags.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-parameters-by-path is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Parameters


--path <value>
[--recursive | --no-recursive]
[--parameter-filters <value>]
[--with-decryption | --no-with-decryption]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]


--path (string)

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

--recursive | --no-recursive (boolean)

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 action recursively for /a and view /a/b .

--parameter-filters (list)

Filters to limit the request results.


You can't filter using the parameter name.

Shorthand Syntax:

Key=string,Option=string,Values=string,string ...

JSON Syntax:

    "Key": "string",
    "Option": "string",
    "Values": ["string", ...]

--with-decryption | --no-with-decryption (boolean)

Retrieve all parameters in a hierarchy with their value decrypted.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To list parameters in a specific path

This example lists parameters within a specific hierarchy.


aws ssm get-parameters-by-path --path "/site/newyork/department/"


  "Parameters": [
          "Name": "/site/newyork/department/marketing",
          "Type": "String",
          "Value": "Floor 2",
          "Version": 1,
          "LastModifiedDate": 1530018761.888,
          "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/site/newyork/department/marketing"
          "Name": "/site/newyork/department/infotech",
          "Type": "String",
          "Value": "Floor 3",
          "Version": 1,
          "LastModifiedDate": 1530018823.429,
          "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter//site/newyork/department/infotech"


Parameters -> (list)

A list of parameters found in the specified hierarchy.


An Amazon EC2 Systems Manager parameter in Parameter Store.

Name -> (string)

The name of the parameter.

Type -> (string)

The type of parameter. Valid values include the following: String, String list, Secure string.

Value -> (string)

The parameter value.

Version -> (long)

The parameter version.

Selector -> (string)

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:



SourceResult -> (string)

Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.

LastModifiedDate -> (timestamp)

Date the parameter was last changed or updated and the parameter version was created.

ARN -> (string)

The Amazon Resource Name (ARN) of the parameter.

NextToken -> (string)

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