CmdID / aws / aws ssm

aws ssm describe-parameters

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option. AWS CLI reference

2 examples 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To list all parameters

The following describe-parameters example lists all parameters in the current AWS account and Region.

aws ssm describe-parametersIdentify

Its output, shortened

{
    "Parameters": [
        {
            "Name": "MySecureStringParameter",
            "Type": "SecureString",
            "KeyId": "alias/aws/ssm",
            "LastModifiedDate": 1582155479.205,
            "LastModifiedUser": "arn:aws:sts::123456789012:assumed-role/Admin/Richard-Roe-Managed",
            "Description": "This is a SecureString parameter",
            "Version": 2,
            "Tier": "Advanced",
            "Policies": [
                {
                    "PolicyText": "{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2020-07-07T22:30:00Z\"}}",
                    "PolicyType": "Expiration",
                    "PolicyStatus": "Pending"
                },
                {
                    "PolicyText": "{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"12\",\"Unit\":\"Hours\"}}",
                    "PolicyType": "ExpirationNotification",
                    "PolicyStatus": "Pending"
                }
            ]
        },
        {
            "Name": "MyStringListParameter",
            "Type": "StringList",
            "LastModifiedDate": 1582154764.222,
            "LastModifiedUser": "arn:aws:iam::123456789012:user/Mary-Major",
            "Description": "This is a StringList parameter",
… 25 more lines

Example 2: To list all parameters matching specific metadata

The following describe-parameters example lists all parameters matching a filter.

aws ssm describe-parameters --filters "Key=Type,Values=StringList"Identify

--filtersThis data type is deprecated.

Its output

{
    "Parameters": [
        {
            "Name": "MyStringListParameter",
            "Type": "StringList",
            "LastModifiedDate": 1582154764.222,
            "LastModifiedUser": "arn:aws:iam::123456789012:user/Mary-Major",
            "Description": "This is a StringList parameter",
            "Version": 1,
            "Tier": "Standard",
            "Policies": []
        }
    ]
}

For more information, see Searching for Parameter Store parameters in Systems Manager in the AWS Systems Manager User Guide.

Options

5 in the AWS CLI reference

--filtersThis data type is deprecated.

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

--next-tokenThe token for the next set of items to return.

--parameter-filtersFilters to limit the request results.

--sharedLists parameters that are shared with you.