/ - Amazon Simple Systems Manager (SSM)

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

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

AssociationFilterList

array[object (AssociationFilter) {2}]

optional

One or more filters. Use a filter to return a more specific list of results.

>= 1 items

key

enum<string>

required

The name of the filter.

Allowed values:

InstanceIdNameAssociationIdAssociationStatusNameLastExecutedBeforeLastExecutedAfterAssociationNameResourceGroupName

value

string

required

The filter value.

>= 1 characters

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

Associations

array[object (Association) {12}]

optional

The associations.

Name

string

optional

The name of the SSM document.

Match pattern:

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

InstanceId

string

optional

The managed node ID.

Match pattern:

(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

AssociationId

string

optional

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

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]*)

DocumentVersion

string

optional

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

Match pattern:

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

Targets

array [object]

optional

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

>= 0 items<= 5 items

LastExecutionDate

string <date-time>

optional

The date on which the association was last run.

Overview

object

optional

Information about the association.

ScheduleExpression

string

optional

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

>= 1 characters<= 256 characters

AssociationName

string

optional

The association name.

Match pattern:

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

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 to use when requesting the next set of items. If there are no additional items to return, the string is empty.

🟠480InternalServerError

🟠481InvalidNextToken