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


Updates the status of the Systems Manager document associated with the specified instance.

Request Syntax

{ "AssociationStatus": { "AdditionalInfo": "string", "Date": number, "Message": "string", "Name": "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.


The association status.

Type: AssociationStatus object

Required: Yes


The ID of the instance.

Type: String

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

Required: Yes


The name of the Systems Manager document.

Type: String

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

Required: Yes

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.


Information about the association.

Type: AssociationDescription object


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


The specified association does not exist.

HTTP Status Code: 400


An error occurred on the server side.

HTTP Status Code: 400


The specified document does not exist.

HTTP Status Code: 400


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


The updated status is the same as the current status.

HTTP Status Code: 400


There are concurrent updates for a resource that supports one update at a time.

HTTP Status Code: 400

See Also

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