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


Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Request Syntax

{ "Filters": [ { "Key": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string", "ParameterFilters": [ { "Key": "string", "Option": "string", "Values": [ "string" ] } ] }

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.


One or more filters. Use a filter to return a more specific list of results.

Type: Array of ParametersFilter objects

Required: No


The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No


The token for the next set of items to return. (You received this token from a previous call.)

Type: String

Required: No


Filters to limit the request results.

Type: Array of ParameterStringFilter objects

Required: No

Response Syntax

{ "NextToken": "string", "Parameters": [ { "AllowedPattern": "string", "Description": "string", "KeyId": "string", "LastModifiedDate": number, "LastModifiedUser": "string", "Name": "string", "Type": "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.


The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

Type: String


Parameters returned by the request.

Type: Array of ParameterMetadata objects


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


An error occurred on the server side.

HTTP Status Code: 400


The specified key is not valid.

HTTP Status Code: 400


The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

HTTP Status Code: 400


The filter value is not valid. Verify the value and try again.

HTTP Status Code: 400


The specified token is not valid.

HTTP Status Code: 400


Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 95 X-Amz-Target: AmazonSSM.DescribeParameters X-Amz-Date: 20180316T010204Z 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 { "Filters": [ { "Values": [ "String" ], "Key": "Type" }, { "Values": [ "/Branch312" ], "Key": "Name" } ] }

Sample Response

{ "Parameters": [ { "LastModifiedDate": 1521160696.821, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer1", "Policies": [], "Type": "String", "Version": 1 }, { "LastModifiedDate": 1521160709.358, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer2", "Policies": [], "Type": "String", "Version": 1 }, { "LastModifiedDate": 1521160717.945, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer3", "Policies": [], "Type": "String", "Version": 1 }, { "LastModifiedDate": 1521161236.491, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer4", "Policies": [], "Type": "String", "Version": 2 }, { "LastModifiedDate": 1521160733.485, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer5", "Policies": [], "Type": "String", "Version": 1 }, { "LastModifiedDate": 1521160740.142, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mateo.Jackson", "Name": "/Branch312/Dev/Engineer6", "Policies": [], "Type": "String", "Version": 1 }, { "LastModifiedDate": 1521160747.499, "LastModifiedUser": "arn:aws:iam::111122223333:user/Mary.Major", "Name": "/Branch312/Dev/Intern", "Policies": [], "Type": "String", "Version": 1 }, { "LastModifiedDate": 1521160588.291, "LastModifiedUser": "arn:aws:iam::111122223333:user/John.Stiles", "Name": "/Branch312/Dev/TeamLead", "Policies": [], "Type": "String", "Version": 1 } ] }

See Also

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