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

GetParameter

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

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.

Name

The name of the parameter you want to query.

Type: String

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

Required: Yes

WithDecryption

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.

Parameter

Information about a parameter.

Type: Parameter object

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 is not valid.

HTTP Status Code: 400

ParameterNotFound

The parameter could not be found. Verify the name and try again.

HTTP Status Code: 400

ParameterVersionNotFound

The specified parameter version was not found. Verify the parameter name and version, and try again.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetParameter.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
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
    }
}