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

UpdateAssociation

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

Request Syntax

{
   "AssociationId": "string",
   "AssociationName": "string",
   "AssociationVersion": "string",
   "DocumentVersion": "string",
   "Name": "string",
   "OutputLocation": { 
      "S3Location": { 
         "OutputS3BucketName": "string",
         "OutputS3KeyPrefix": "string",
         "OutputS3Region": "string"
      }
   },
   "Parameters": { 
      "string" : [ "string" ]
   },
   "ScheduleExpression": "string",
   "Targets": [ 
      { 
         "Key": "string",
         "Values": [ "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 ID of the association you want to update.

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: Yes

AssociationName

The name of the association that you want to update.

Type: String

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

Required: No

AssociationVersion

This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

Type: String

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

Required: No

DocumentVersion

The document version you want update for the association.

Type: String

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

Required: No

Name

The name of the association document.

Type: String

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

Required: No

OutputLocation

An Amazon S3 bucket where you want to store the results of this request.

Type: InstanceAssociationOutputLocation object

Required: No

Parameters

The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

Type: String to array of strings map

Required: No

ScheduleExpression

The cron expression used to schedule the association that you want to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Targets

The targets of the association.

Type: Array of Target objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

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

The description of the association that was updated.

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

AssociationVersionLimitExceeded

You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

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

InvalidDocumentVersion

The document version is not valid or does not exist.

HTTP Status Code: 400

InvalidOutputLocation

The output location is not valid or does not exist.

HTTP Status Code: 400

InvalidParameters

You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

HTTP Status Code: 400

InvalidSchedule

The schedule is invalid. Verify your cron or rate expression and try again.

HTTP Status Code: 400

InvalidTarget

The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

HTTP Status Code: 400

InvalidUpdate

The update is not valid.

HTTP Status Code: 400

TooManyUpdates

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: