Get information about a single parameter by specifying the parameter name.
Note
To get information about more than one parameter at a time, use the GetParameters operation.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-parameter
--name <value>
[--with-decryption | --no-with-decryption]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--name
(string)
The name of the parameter you want to query.
To query by parameter label, use
"Name": "name:label"
. To query by parameter version, use"Name": "name:version"
.
--with-decryption
| --no-with-decryption
(boolean)
Return decrypted values for secure string parameters. This flag is ignored for
String
andStringList
parameter types.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. 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.
Example 1: To display the value of a parameter
The following get-parameter
example lists the value for the specified single parameter.
aws ssm get-parameter \
--name "MyStringParameter"
Output:
{
"Parameter": {
"Name": "MyStringParameter",
"Type": "String",
"Value": "Veni",
"Version": 1,
"LastModifiedDate": 1530018761.888,
"ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter"
"DataType": "text"
}
}
For more information, see Working with Parameter Store in the AWS Systems Manager User Guide.
Example 2: To decrypt the value of a SecureString parameter
The following get-parameter
example decrypts the value of the specified SecureString
parameter.
aws ssm get-parameter \
--name "MySecureStringParameter" \
--with-decryption
Output:
{
"Parameter": {
"Name": "MySecureStringParameter",
"Type": "SecureString",
"Value": "16679b88-310b-4895-a943-e0764EXAMPLE",
"Version": 2,
"LastModifiedDate": 1582155479.205,
"ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MySecureStringParameter"
"DataType": "text"
}
}
For more information, see Working with Parameter Store in the AWS Systems Manager User Guide.
Example 3: To display the value of a parameter using labels
The following get-parameter
example lists the value for the specified single parameter with a specified label.
aws ssm get-parameter \
--name "MyParameter:label"
Output:
{
"Parameter": {
"Name": "MyParameter",
"Type": "String",
"Value": "parameter version 2",
"Version": 2,
"Selector": ":label",
"LastModifiedDate": "2021-07-12T09:49:15.865000-07:00",
"ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter",
"DataType": "text"
}
}
For more information, see Working with parameter labels in the AWS Systems Manager User Guide.
Example 4: To display the value of a parameter using versions
The following get-parameter
example lists the value for the specified single parameter version.
aws ssm get-parameter \
--name "MyParameter:2"
Output:
{
"Parameter": {
"Name": "MyParameter",
"Type": "String",
"Value": "parameter version 2",
"Version": 2,
"Selector": ":2",
"LastModifiedDate": "2021-07-12T09:49:15.865000-07:00",
"ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter",
"DataType": "text"
}
}
For more information, see Working with parameter labels in the AWS Systems Manager User Guide.
Parameter -> (structure)
Information about a parameter.
Name -> (string)
The name of the parameter.
Type -> (string)
The type of parameter. Valid values include the following:
String
,StringList
, andSecureString
.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:
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
oraws:ec2:image
. The default istext
.