get-parameters-by-path ¶

  get-parameters-by-path
--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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--path (string)
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
--recursive | --no-recursive (boolean)
Retrieve all parameters within a hierarchy.
Warning
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 .
--parameter-filters (list)
Filters to limit the request results.
Note
The following Key values are supported for GetParametersByPath : Type , KeyId , and Label .
The following Key values aren't supported for GetParametersByPath : tag , DataType , Name , Path , and Tier .
(structure)
One or more filters. Use a filter to return a more specific list of results.
Key -> (string)
The name of the filter.
The ParameterStringFilter object is used by the  DescribeParameters and  GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.
For DescribeParameters , all of the listed patterns are valid except Label .
For GetParametersByPath , the following patterns listed for Key aren't valid: tag , DataType , Name , Path , and Tier .
For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide .
Option -> (string)
For all filters used with  DescribeParameters , valid options include Equals and BeginsWith . The Name filter additionally supports the Contains option. (Exception: For filters using the key Path , valid options include Recursive and OneLevel .)
For filters used with  GetParametersByPath , valid options include Equals and BeginsWith . (Exception: For filters using Label as the Key name, the only valid option is Equals .)
Values -> (list)
The value you want to search for.
(string)
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.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To list parameters in a specific path
The following get-parameters-by-path example lists the parameters within the specified hierarchy.
aws ssm get-parameters-by-path \
    --path "/site/newyork/department/"
Output:
    "Parameters": [
            "Name": "/site/newyork/department/marketing",
            "Type": "String",
            "Value": "Floor 2",
            "Version": 1,
            "LastModifiedDate": 1530018761.888,
            "ARN": "arn:aws:ssm:us-east-1:111222333444: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:111222333444:parameter/site/newyork/department/infotech"
For more information, see Working with parameter hierarchies in the AWS Systems Manager User Guide.
Output¶
Parameters -> (list)
A list of parameters found in the specified hierarchy.
(structure)
An Amazon Web Services 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 , StringList , and SecureString .
Note
If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.
Value -> (string)
The parameter value.
Note
If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.
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:
parameter_name:version
parameter_name:label
SourceResult -> (string)
Applies to parameters that reference information in other Amazon Web Services 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.
DataType -> (string)
The data type of the parameter, such as text or aws:ec2:image . The default is text .
NextToken -> (string)
The token for the next set of items to return. Use this token to get the next set of results.