Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetParameters

Get information about one or more parameters by specifying multiple parameter names.

Note

To get information about a single parameter, you can use the GetParameter operation instead.

Request Syntax


{
   "Names": [ "string" ],
   "WithDecryption": boolean
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Names

The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.

To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

Note

The results for GetParameters requests are listed in alphabetical order in query responses.

For information about shared parameters, see Working with shared parameters in the AWS Systems Manager User Guide.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

WithDecryption

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

Type: Boolean

Required: No

Response Syntax


{
   "InvalidParameters": [ "string" ],
   "Parameters": [ 
      { 
         "ARN": "string",
         "DataType": "string",
         "LastModifiedDate": number,
         "Name": "string",
         "Selector": "string",
         "SourceResult": "string",
         "Type": "string",
         "Value": "string",
         "Version": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InvalidParameters

A list of parameters that aren't formatted correctly or don't run during an execution.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Parameters

A list of details for a parameter.

Type: Array of Parameter objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidKeyId

The query key ID isn't valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetParameters.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 73
X-Amz-Target: AmazonSSM.GetParameters
X-Amz-Date: 20240316T001029Z
User-Agent: aws-cli/1.11.180 Python/2.7.9 Windows/8 botocore/1.7.38
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240316/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE

{
    "Names": [
        "EC2DevServerTypo",
        "EC2DevServerType",
        "EC2TestServerType",
        "EC2ProdServerType"
    ]
}

Sample Response


{
    "InvalidParameters": [
        {
            "Name": "EC2DevServerTypo"
            }
     ],
    "Parameters": [
        {
            "Name": "EC2DevServerType",
            "Type": "String",
            "Value": "t2.micro",
            "Version": 2
        },
        {
            "Name": "EC2ProdServerType",
            "Type": "String",
            "Value": "m4.large",
            "Version": 1
        },
        {
            "Name": "EC2TestServerType",
            "Type": "String",
            "Value": "t2.large",
            "Version": 3
        }
    ]
}