Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

GetParameters

Get details of a parameter.

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

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

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": [ 
      { 
         "Name": "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 are not formatted correctly or do not run when executed.

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

InvalidKeyId

The query key ID is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: