Table Of Contents

Feedback

User Guide

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

[ aws . ssm ]

get-parameters-by-path

Description

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 next-token . You can specify the next-token in a subsequent call to get the next set of results.

See also: AWS API Documentation

Synopsis

  get-parameters-by-path
--path <value>
[--recursive | --no-recursive]
[--parameter-filters <value>]
[--with-decryption | --no-with-decryption]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--path (string)

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. For example: /Finance/Prod/IAD/WinServ2016/license15

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

Retrieve all parameters within a hierarchy.

--parameter-filters (list)

Filters to limit the request results.

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.

--max-results (integer)

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.

--next-token (string)

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

--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.

--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.

Output

Parameters -> (list)

A list of parameters found in the specified hierarchy.

(structure)

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.

NextToken -> (string)

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