ListAssociations
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 Systems Manager.
Request Syntax
{
"AssociationFilterList": [
{
"key": "string
",
"value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AssociationFilterList
-
One or more filters. Use a filter to return a more specific list of results.
Note
Filtering associations using the
InstanceID
attribute only returns legacy associations created using theInstanceID
attribute. Associations targeting the managed node that are part of the Target AttributesResourceGroup
orTags
aren't returned.Type: Array of AssociationFilter objects
Array Members: Minimum number of 1 item.
Required: No
- MaxResults
-
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Required: No
Response Syntax
{
"Associations": [
{
"AssociationId": "string",
"AssociationName": "string",
"AssociationVersion": "string",
"DocumentVersion": "string",
"Duration": number,
"InstanceId": "string",
"LastExecutionDate": number,
"Name": "string",
"Overview": {
"AssociationStatusAggregatedCount": {
"string" : number
},
"DetailedStatus": "string",
"Status": "string"
},
"ScheduleExpression": "string",
"ScheduleOffset": number,
"TargetMaps": [
{
"string" : [ "string" ]
}
],
"Targets": [
{
"Key": "string",
"Values": [ "string" ]
}
]
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Associations
-
The associations.
Type: Array of Association objects
- NextToken
-
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidNextToken
-
The specified token isn't valid.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of ListAssociations.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.ListAssociations
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.17.12 Python/3.6.8 Darwin/18.7.0 botocore/1.14.12
X-Amz-Date: 20240325T143814Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240325/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 2
Sample Response
{
"Associations": [
{
"AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
"AssociationVersion": "1",
"LastExecutionDate": 1582037438.692,
"Name": "AWS-UpdateSSMAgent",
"Overview": {
"AssociationStatusAggregatedCount": {
"Success": 3
},
"DetailedStatus": "Success",
"Status": "Success"
},
"Targets": [
{
"Key": "tag:ssm",
"Values": [
"true"
]
}
]
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: