/

The Amazon SSM multi-region endpoint

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

POST

Retrieves all versions of an association for a specific association ID.

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 '{
    "AssociationId": "string",
    "MaxResults": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
    "AssociationVersions": [],
    "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

AssociationId

string

required

The association ID for which you want to view all versions.

Match pattern:

[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

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

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

Examples

Responses

🟢200Success

application/json

Body

AssociationVersions

array[object (AssociationVersionInfo) {19}]

optional

Information about all versions of the association for the specified association ID.

>= 1 items

AssociationId

string

optional

The ID created by the system when the association was created.

Match pattern:

[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

AssociationVersion

string

optional

The association version.

Match pattern:

([$]LATEST)|([1-9][0-9]*)

CreatedDate

string <date-time>

optional

The date the association version was created.

Name

string

optional

The name specified when the association was created.

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

DocumentVersion

string

optional

The version of an Amazon Web Services Systems Manager document (SSM document) used when the association version was created.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Parameters

object

optional

Parameters specified when the association version was created.

Targets

array [object]

optional

The targets specified for the association when the association version was created.

>= 0 items<= 5 items

ScheduleExpression

string

optional

The cron or rate schedule specified for the association when the association version was created.

>= 1 characters<= 256 characters

OutputLocation

object

optional

The location in Amazon S3 specified for the association when the association version was created.

AssociationName

string

optional

The name specified for the association version when the association version was created.

Match pattern:

^[a-zA-Z0-9_\-.]{3,128}$

MaxErrors

string

optional

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$

MaxConcurrency

string

optional

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for MaxConcurrency.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$

ComplianceSeverity

enum<string>

optional

The severity level that is assigned to the association.

Allowed values:

CRITICALHIGHMEDIUMLOWUNSPECIFIED

SyncCompliance

enum<string>

optional

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

Allowed values:

AUTOMANUAL

ApplyOnlyAtCronInterval

boolean

optional

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions.

CalendarNames

array[string]

optional

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar.

TargetLocations

array[object (TargetLocation) {6}]

optional

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you wanted to run the association when this association version was created.

>= 1 items<= 100 items

ScheduleOffset

integer

optional

Number of days to wait after the scheduled day to run an association.

>= 1<= 6

TargetMaps

array[object (TargetMap)]

optional

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

>= 0 items<= 300 items

NextToken

string

optional

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

🟠480InternalServerError

🟠481InvalidNextToken

🟠482AssociationDoesNotExist