Use GetParameters with a CLI - AWS Systems Manager

Use GetParameters with a CLI

The following code examples show how to use GetParameters.

CLI
AWS CLI

Example 1: To list the values for a parameter

The following get-parameters example lists the values for the three specified parameters.

aws ssm get-parameters \ --names "MyStringParameter" "MyStringListParameter" "MyInvalidParameterName"

Output:

{ "Parameters": [ { "Name": "MyStringListParameter", "Type": "StringList", "Value": "alpha,beta,gamma", "Version": 1, "LastModifiedDate": 1582154764.222, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringListParameter" "DataType": "text" }, { "Name": "MyStringParameter", "Type": "String", "Value": "Vici", "Version": 3, "LastModifiedDate": 1582156117.545, "ARN": "arn:aws:ssm:us-east-2:111222333444:parameter/MyStringParameter" "DataType": "text" } ], "InvalidParameters": [ "MyInvalidParameterName" ] }

For more information, see Working with Parameter Store in the AWS Systems Manager User Guide.

Example 2: To list names and values of multiple parameters using the ``--query`` option

The following get-parameters example lists the names and values for the specified parameters.

aws ssm get-parameters \ --names MyStringParameter MyStringListParameter \ --query "Parameters[*].{Name:Name,Value:Value}"

Output:

[ { "Name": "MyStringListParameter", "Value": "alpha,beta,gamma" }, { "Name": "MyStringParameter", "Value": "Vidi" } ]

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:

{ "Parameters": [ { "Name": "MyLabelParameter", "Type": "String", "Value": "parameter by label", "Version": 1, "Selector": ":label", "LastModifiedDate": "2021-07-12T09:49:15.865000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/MyParameter", "DataType": "text" }, { "Name": "MyVersionParameter", "Type": "String", "Value": "parameter by version", "Version": 2, "Selector": ":2", "LastModifiedDate": "2021-03-24T16:20:28.236000-07:00", "ARN": "arn:aws:ssm:us-west-2:786973925828:parameter/unlabel-param", "DataType": "text" } ], "InvalidParameters": [] }

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

  • For API details, see GetParameters in AWS CLI Command Reference.

PowerShell
Tools for PowerShell

Example 1: This example lists the values for a parameter.

Get-SSMParameterValue -Name "Welcome"

Output:

InvalidParameters Parameters ----------------- ---------- {} {Welcome}

Example 2: This example lists the details of the value.

(Get-SSMParameterValue -Name "Welcome").Parameters

Output:

Name Type Value ---- ---- ----- Welcome String Good day, Sunshine!
  • For API details, see GetParameters in AWS Tools for PowerShell Cmdlet Reference.

For a complete list of AWS SDK developer guides and code examples, see Using this service with an AWS SDK. This topic also includes information about getting started and details about previous SDK versions.