UpdateAssociation
Updates an association. You can update the association name and version, the document
version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you
call UpdateAssociation
, the system removes all optional parameters from the request
and overwrites the association with null values for those parameters. This is by design. You must
specify all optional parameters in the call, even if you are not changing the parameters. This
includes the Name
parameter. Before calling this API action, we recommend that you
call the DescribeAssociation API operation and make a note of all optional
parameters required for your UpdateAssociation
call.
In order to call this API operation, a user, group, or role must be granted permission to
call the DescribeAssociation API operation. If you don't have permission to
call DescribeAssociation
, then you receive the following error: An error
occurred (AccessDeniedException) when calling the UpdateAssociation operation: User:
<user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource:
<resource_arn>
Important
When you update an association, the association immediately runs against the specified
targets. You can add the ApplyOnlyAtCronInterval
parameter to run the association
during the next schedule run.
Request Syntax
{
"AlarmConfiguration": {
"Alarms": [
{
"Name": "string
"
}
],
"IgnorePollAlarmFailure": boolean
},
"ApplyOnlyAtCronInterval": boolean
,
"AssociationId": "string
",
"AssociationName": "string
",
"AssociationVersion": "string
",
"AutomationTargetParameterName": "string
",
"CalendarNames": [ "string
" ],
"ComplianceSeverity": "string
",
"DocumentVersion": "string
",
"Duration": number
,
"MaxConcurrency": "string
",
"MaxErrors": "string
",
"Name": "string
",
"OutputLocation": {
"S3Location": {
"OutputS3BucketName": "string
",
"OutputS3KeyPrefix": "string
",
"OutputS3Region": "string
"
}
},
"Parameters": {
"string
" : [ "string
" ]
},
"ScheduleExpression": "string
",
"ScheduleOffset": number
,
"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
" ]
}
]
}
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.
- AlarmConfiguration
-
The details for the CloudWatch alarm you want to apply to an automation or command.
Type: AlarmConfiguration object
Required: No
- ApplyOnlyAtCronInterval
-
By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions.
If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the
Latest
version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association.You can reset this option. To do so, specify the
no-apply-only-at-cron-interval
parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified.Type: Boolean
Required: No
- 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
- AutomationTargetParameterName
-
Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of AWS Systems Manager.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: No
- CalendarNames
-
The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see AWS Systems Manager Change Calendar.
Type: Array of strings
Required: No
- ComplianceSeverity
-
The severity level to assign to the association.
Type: String
Valid Values:
CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED
Required: No
- DocumentVersion
-
The document version you want update for the association.
Important
State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the
default
version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version todefault
.Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)
Required: No
- Duration
-
The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.
The
Duration
parameter applies only when both these conditions are true:-
The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.
-
The command specifies the
ApplyOnlyAtCronInterval
parameter, which means that the association doesn't run immediately after it is updated, but only according to the specified schedule.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 24.
Required: No
-
- MaxConcurrency
-
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new managed node starts and attempts to run an association while Systems Manager is running
MaxConcurrency
associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified forMaxConcurrency
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 7.
Pattern:
^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$
Required: No
- MaxErrors
-
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set
MaxError
to 10%, then the system stops sending the request when the sixth error is received.Executions that are already running an association when
MaxErrors
is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, setMaxConcurrency
to 1 so that executions proceed one at a time.Type: String
Length Constraints: Minimum length of 1. Maximum length of 7.
Pattern:
^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$
Required: No
- Name
-
The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For Systems Manager document (SSM document) that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example,
AWS-ApplyPatchBaseline
orMy-Document
.Type: String
Pattern:
^[a-zA-Z0-9_\-.:/]{3,128}$
Required: No
- OutputLocation
-
An 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, a capability of AWS Systems Manager, 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
- ScheduleOffset
-
Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of
cron(0 0 ? * THU#2 *)
, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see Reference: Cron and rate expressions for Systems Manager in the AWS Systems Manager User Guide.Note
To use offsets, you must specify the
ApplyOnlyAtCronInterval
parameter. This option tells the system not to run an association immediately after you create it.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 6.
Required: No
- SyncCompliance
-
The mode for generating association compliance. You can specify
AUTO
orMANUAL
. InAUTO
mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association isCOMPLIANT
. If the association execution doesn't run successfully, the association isNON-COMPLIANT
.In
MANUAL
mode, you must specify theAssociationId
as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a capability of AWS Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.By default, all associations use
AUTO
mode.Type: String
Valid Values:
AUTO | MANUAL
Required: No
- TargetLocations
-
A location is a combination of AWS Regions and AWS accounts where you want to run the association. Use this action to update an association in multiple Regions and multiple accounts.
Type: Array of TargetLocation objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- TargetMaps
-
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
Type: Array of string to array of strings maps
Array Members: Minimum number of 0 items. Maximum number of 300 items.
Map Entries: Maximum number of 20 items.
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 50.
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": {
"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
-
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 doesn't 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: 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
- InvalidDocumentVersion
-
The document version isn't valid or doesn't exist.
HTTP Status Code: 400
- InvalidOutputLocation
-
The output location isn't valid or doesn't exist.
HTTP Status Code: 400
- InvalidParameters
-
You must specify values for all required parameters in the AWS Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM 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 isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
HTTP Status Code: 400
- InvalidTargetMaps
-
TargetMap parameter isn't valid.
HTTP Status Code: 400
- InvalidUpdate
-
The update isn't valid.
HTTP Status Code: 400
- TooManyUpdates
-
There are concurrent updates for a resource that supports one update at a time.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of UpdateAssociation.
Sample Request
POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.UpdateAssociation
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: 20240325T171857Z
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: 87
{
"AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
"ComplianceSeverity": "HIGH"
}
Sample Response
{
"AssociationDescription": {
"ApplyOnlyAtCronInterval": false,
"AssociationId": "fa94c678-85c6-4d40-926b-7c791EXAMPLE",
"AssociationVersion": "2",
"ComplianceSeverity": "HIGH",
"Date": 1561053271.583,
"DocumentVersion": "$DEFAULT",
"LastExecutionDate": 1582037438.692,
"LastSuccessfulExecutionDate": 1582037438.692,
"LastUpdateAssociationDate": 1585156739.103,
"Name": "AWS-UpdateSSMAgent",
"Overview": {
"DetailedStatus": "Creating",
"Status": "Pending"
},
"Targets": [
{
"Key": "tag:ssm",
"Values": [
"true"
]
}
]
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: