/ - Amazon Simple Systems Manager (SSM)

Retrieves the history of all changes to a parameter.

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Name": "string", "WithDecryption": true, "MaxResults": 0, "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

Name

string

required

The name of the parameter for which you want to review history.

>= 1 characters<= 2048 characters

WithDecryption

boolean

optional

Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

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 (ParameterHistory) {13}]

optional

A list of parameters returned by the request.

Name

string

optional

The name of the parameter.

>= 1 characters<= 2048 characters

Type

enum<string>

optional

The type of parameter used.

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

Information about the parameter.

>= 0 characters<= 1024 characters

Value

string <password>

optional

The parameter value.

AllowedPattern

string

optional

Parameter names can include the following letters and symbols.

a-zA-Z0-9_.-

>= 0 characters<= 1024 characters

Version

integer

optional

The parameter version.

Labels

array[string]

optional

Labels assigned to the parameter version.

>= 1 items<= 10 items

Tier

enum<string>

optional

The parameter tier.

Allowed values:

StandardAdvancedIntelligent-Tiering

Policies

array[object (ParameterInlinePolicy) {3}]

optional

Information about the policies assigned to a parameter.

Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.

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. If there are no additional items to return, the string is empty.

🟠480InternalServerError

🟠481ParameterNotFound

🟠482InvalidNextToken

🟠483InvalidKeyId