Table Of Contents


User Guide

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

[ aws . ssm ]



Get details of a parameter. Don't confuse this API action with the GetParameter API action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--names <value>
[--with-decryption | --no-with-decryption]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--names (list)

Names of the parameters for which you want to query information.


"string" "string" ...

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

Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

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

--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 the values for a parameter

This example lists the values for a parameter.


aws ssm get-parameters --names "helloWorld"


  "Parameters": [
          "Name": "helloWorld",
          "Type": "String",
          "Value": "good day sunshine",
          "Version": 1,
          "LastModifiedDate": 1542308384.49,
          "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/helloWorld"
  "InvalidParameters": []

To list the name and value of multiple parameters the --query argument can be used with a list of names.


aws ssm get-parameters --names key1 key2 --query "Parameters[*].{Name:Name,Value:Value}"


      "Name": "key1",
      "Value": "value1"
      "Name": "key2",
      "Value": "value2"


Parameters -> (list)

A list of details for a parameter.


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.

InvalidParameters -> (list)

A list of parameters that are not formatted correctly or do not run during an execution.