GetParameter - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Get information about a single parameter by specifying the parameter name.


To get information about more than one parameter at a time, use the GetParameters operation.

Request Syntax

{ "Name": "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.


The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

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

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

Type: String

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

Required: Yes


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

Type: Boolean

Required: No

Response Syntax

{ "Parameter": { "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.


Information about a parameter.

Type: Parameter object


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


An error occurred on the server side.

HTTP Status Code: 500


The query key ID isn't valid.

HTTP Status Code: 400


The parameter couldn't be found. Verify the name and try again.

HTTP Status Code: 400


The specified parameter version wasn't found. Verify the parameter name and version, and try again.

HTTP Status Code: 400



This example illustrates one usage of GetParameter.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 29 X-Amz-Target: AmazonSSM.GetParameter X-Amz-Date: 20180316T005724Z 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/20180316/us-east-2/ssm/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "Name": "MyGitHubPassword" }

Sample Response

{ "Parameter": { "ARN": "arn:aws:ssm:us-east-2:111122223333:parameter/MyGitHubPassword", "DataType": "text", "LastModifiedDate": 1582657288.8, "Name": "MyGitHubPassword", "Type": "SecureString", "Value": "AYA39c3b3042cd2aEXAMPLE/AKIAIOSFODNN7EXAMPLE/fh983hg9awEXAMPLE==", "Version": 3 } }

See Also

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