Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

DescribeAssociation

Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance 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 an instance, use ListInstanceAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Type: String

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

Required: No

InstanceId

The instance ID.

Type: String

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

Required: No

Name

The name of the Systems Manager document.

Type: String

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

Required: No

Response Syntax

{
   "AssociationDescription": { 
      "AssociationId": "string",
      "AssociationName": "string",
      "AssociationVersion": "string",
      "Date": number,
      "DocumentVersion": "string",
      "InstanceId": "string",
      "LastExecutionDate": number,
      "LastSuccessfulExecutionDate": number,
      "LastUpdateAssociationDate": number,
      "Name": "string",
      "OutputLocation": { 
         "S3Location": { 
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string",
            "OutputS3Region": "string"
         }
      },
      "Overview": { 
         "AssociationStatusAggregatedCount": { 
            "string" : number 
         },
         "DetailedStatus": "string",
         "Status": "string"
      },
      "Parameters": { 
         "string" : [ "string" ]
      },
      "ScheduleExpression": "string",
      "Status": { 
         "AdditionalInfo": "string",
         "Date": number,
         "Message": "string",
         "Name": "string"
      },
      "Targets": [ 
         { 
            "Key": "string",
            "Values": [ "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 does not exist.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

InvalidAssociationVersion

The version you specified is not 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 document does not exist.

HTTP Status Code: 400

InvalidInstanceId

The following problems can cause this exception:

You do not have permission to access the instance.

The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: