Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeAssociation

Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

Request Syntax


{
   "AssociationId": "string",
   "AssociationVersion": "string",
   "InstanceId": "string",
   "Name": "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.

AssociationId

The association ID for which you want information.

Type: String

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}

Required: No

AssociationVersion

Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for a managed node, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Type: String

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

Required: No

InstanceId

The managed node ID.

Type: String

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

Required: No

Name

The name of the SSM document.

Type: String

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

Required: No

Response Syntax


{
   "AssociationDescription": { 
      "AlarmConfiguration": { 
         "Alarms": [ 
            { 
               "Name": "string"
            }
         ],
         "IgnorePollAlarmFailure": boolean
      },
      "ApplyOnlyAtCronInterval": boolean,
      "AssociationId": "string",
      "AssociationName": "string",
      "AssociationVersion": "string",
      "AutomationTargetParameterName": "string",
      "CalendarNames": [ "string" ],
      "ComplianceSeverity": "string",
      "Date": number,
      "DocumentVersion": "string",
      "Duration": number,
      "InstanceId": "string",
      "LastExecutionDate": number,
      "LastSuccessfulExecutionDate": number,
      "LastUpdateAssociationDate": number,
      "MaxConcurrency": "string",
      "MaxErrors": "string",
      "Name": "string",
      "OutputLocation": { 
         "S3Location": { 
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string",
            "OutputS3Region": "string"
         }
      },
      "Overview": { 
         "AssociationStatusAggregatedCount": { 
            "string" : number 
         },
         "DetailedStatus": "string",
         "Status": "string"
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ScheduleExpression": "string",
      "ScheduleOffset": number,
      "Status": { 
         "AdditionalInfo": "string",
         "Date": number,
         "Message": "string",
         "Name": "string"
      },
      "SyncCompliance": "string",
      "TargetLocations": [ 
         { 
            "Accounts": [ "string" ],
            "ExcludeAccounts": [ "string" ],
            "ExecutionRoleName": "string",
            "IncludeChildOrganizationUnits": boolean,
            "Regions": [ "string" ],
            "TargetLocationAlarmConfiguration": { 
               "Alarms": [ 
                  { 
                     "Name": "string"
                  }
               ],
               "IgnorePollAlarmFailure": boolean
            },
            "TargetLocationMaxConcurrency": "string",
            "TargetLocationMaxErrors": "string",
            "Targets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ],
            "TargetsMaxConcurrency": "string",
            "TargetsMaxErrors": "string"
         }
      ],
      "TargetMaps": [ 
         { 
            "string" : [ "string" ]
         }
      ],
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "string" ]
         }
      ],
      "TriggeredAlarms": [ 
         { 
            "Name": "string",
            "State": "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.

AssociationDescription

Information about the association.

Type: AssociationDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

AssociationDoesNotExist

The specified association doesn't exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidAssociationVersion

The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

HTTP Status Code: 400

InvalidDocument

The specified SSM document doesn't exist.

HTTP Status Code: 400

InvalidInstanceId

The following problems can cause this exception:

You don't have permission to access the managed node.
AWS Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeAssociation.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.DescribeAssociation
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: 20240324T153423Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240324/us-east-2/ssm/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 57

{
    "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE"
}

Sample Response


{
    "AssociationDescription": {
        "ApplyOnlyAtCronInterval": false,
        "AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
        "AssociationVersion": "1",
        "ComplianceSeverity": "UNSPECIFIED",
        "Date": 1561053271.583,
        "DocumentVersion": "$DEFAULT",
        "LastExecutionDate": 1582037438.692,
        "LastSuccessfulExecutionDate": 1582037438.692,
        "LastUpdateAssociationDate": 1561053271.583,
        "Name": "AWS-UpdateSSMAgent",
        "Overview": {
            "AssociationStatusAggregatedCount": {
                "Success": 3
            },
            "DetailedStatus": "Success",
            "Status": "Success"
        },
        "Parameters": {
            "allowDowngrade": [
                "false"
            ],
            "version": [
                ""
            ]
        },
        "Targets": [
            {
                "Key": "tag:ssm",
                "Values": [
                    "true"
                ]
            }
        ]
    }
}