/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Retrieve information about one or more parameters in a specific hierarchy.

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 Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Path": "string",
    "Recursive": true,
    "ParameterFilters": [],
    "WithDecryption": true,
    "MaxResults": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "Parameters": [],
    "NextToken": "string"
}

Request

Query Params

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Path

string

required

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

>= 1 characters<= 2048 characters

Recursive

boolean

optional

Retrieve all parameters within a hierarchy.

ParameterFilters

array[object (ParameterStringFilter) {3}]

optional

Filters to limit the request results.

Key

string

required

The name of the filter.

The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.

For DescribeParameters, all of the listed patterns are valid except Label.

For GetParametersByPath, the following patterns listed for Key aren't valid: tag, DataType, Name, Path, and Tier.

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

>= 1 characters<= 132 characters

Match pattern:

Option

string

optional

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using Label as the Key name, the only valid option is Equals.)

>= 1 characters<= 10 characters

Values

array[string]

optional

The value you want to search for.

>= 1 items<= 50 items

WithDecryption

boolean

optional

Retrieve all parameters in a hierarchy with their value decrypted.

MaxResults

integer

optional

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.

>= 1<= 10

NextToken

string

optional

A token to start the list. Use this token to get the next set of results.

Examples

Responses

🟢200Success

application/json

Body

Parameters

array[object (Parameter) {9}]

optional

A list of parameters found in the specified hierarchy.

Name

string

optional

The name of the parameter.

>= 1 characters<= 2048 characters

Type

enum<string>

optional

The type of parameter. Valid values include the following: String, StringList, and SecureString.

Allowed values:

StringStringListSecureString

Value

string <password>

optional

The parameter value.

Version

integer

optional

The parameter version.

Selector

string

optional

Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

parameter_name:version

parameter_name:label

>= 0 characters<= 128 characters

SourceResult

string

optional

Applies to parameters that reference information in other Amazon Web Services services. SourceResult is the raw result or response from the source.

LastModifiedDate

string <date-time>

optional

Date the parameter was last changed or updated and the parameter version was created.

ARN

string

optional

The Amazon Resource Name (ARN) of the parameter.

DataType

string

optional

The data type of the parameter, such as text or aws:ec2:image. The default is text.

>= 0 characters<= 128 characters

NextToken

string

optional

The token for the next set of items to return. Use this token to get the next set of results.

🟠480InternalServerError

🟠481InvalidFilterKey

🟠482InvalidFilterOption

🟠483InvalidFilterValue

🟠484InvalidKeyId

🟠485InvalidNextToken