/

The Amazon SSM multi-region endpoint

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

POST

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 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 '{
    "Filters": [],
    "ParameterFilters": [],
    "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

Filters

array[object (ParametersFilter) {2}]

optional

This data type is deprecated. Instead, use ParameterFilters.

Key

enum<string>

required

The name of the filter.

Allowed values:

NameTypeKeyId

Values

array[string]

required

The filter values.

>= 1 items<= 50 items

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

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<= 50

NextToken

string

optional

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

Examples

Responses

🟢200Success

application/json

Body

Parameters

array[object (ParameterMetadata) {11}]

optional

Parameters returned by the request.

Name

string

optional

The parameter name.

>= 1 characters<= 2048 characters

Type

enum<string>

optional

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

Allowed values:

StringStringListSecureString

KeyId

string

optional

The ID of the query key used for this parameter.

>= 1 characters<= 256 characters

Match pattern:

^([a-zA-Z0-9:/_-]+)$

LastModifiedDate

string <date-time>

optional

Date the parameter was last changed or updated.

LastModifiedUser

string

optional

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

Description

string

optional

Description of the parameter actions.

>= 0 characters<= 1024 characters

AllowedPattern

string

optional

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

>= 0 characters<= 1024 characters

Version

integer

optional

The parameter version.

Tier

enum<string>

optional

The parameter tier.

Allowed values:

StandardAdvancedIntelligent-Tiering

Policies

array[object (ParameterInlinePolicy) {3}]

optional

A list of policies associated with a 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 to use when requesting the next set of items.

🟠480InternalServerError

🟠481InvalidFilterKey

🟠482InvalidFilterOption

🟠483InvalidFilterValue

🟠484InvalidNextToken