CmdID / aws / aws ssm

aws ssm get-parameters-by-path

Retrieve information about one or more parameters under a specified level in a hierarchy. AWS CLI reference

1 example 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

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/"Identify

--pathThe hierarchy for the parameter.

Its output

{
    "Parameters": [
        {
            "Name": "/site/newyork/department/marketing",
            "Type": "String",
            "Value": "Floor 2",
            "Version": 1,
            "LastModifiedDate": 1530018761.888,
            "ARN": "arn:aws:ssm:us-west-2: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-west-2:123456789012:parameter/site/newyork/department/infotech"
        }
    ]
}

For more information, see Working with parameter hierarchies in the AWS Systems Manager User Guide.

Options

6 in the AWS CLI reference

--max-resultsThe maximum number of items to return for this call.

--next-tokenA token to start the list.

--parameter-filtersFilters to limit the request results.

--pathThe hierarchy for the parameter.

--recursiveRetrieve all parameters within a hierarchy.

--with-decryptionRetrieve all parameters in a hierarchy with their value decrypted.