[ aws . ssm ]

get-parameter

Description

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-parameter
--name <value>
[--with-decryption | --no-with-decryption]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the parameter you want to query.

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

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.

Examples

Example 1: To list the value for a parameter

The following get-parameter example lists the value for a parameter.

Command:

aws ssm get-parameter --name "helloWorld"

Output:

{
    "Parameter": {
        "Name": "helloWorld",
        "Type": "String",
        "Value": "Good day sunshine",
        "Version": 1,
        "LastModifiedDate": 1530018761.888,
        "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/helloWorld"
    }
}

Example 2: To decrypt the value for a parmeter

The following get-parameter example decrypts the value of a SecureString parameter.

Command:

aws ssm get-parameter \
    --name "helloSecureWorld" \
    --with-decryption

Output:

{
    "Parameter": {
        "Name": "helloSecureWorld",
        "Type": "SecureString",
        "Value": "Good day sunshine",
        "Version": 1,
        "LastModifiedDate": 1530018761.888,
        "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/helloSecureWorld"
    }
}

Output

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, 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:

parameter_name:version

parameter_name:label

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.