/

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

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480InternalServerError

🟠481InvalidFilterKey

🟠482InvalidFilterOption

🟠483InvalidFilterValue

🟠484InvalidKeyId

🟠485InvalidNextToken

Modified at 2023-08-15 10:32:33