/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "string",
    "InstanceId": "string",
    "AssociationStatus": {
        "Date": "string",
        "Name": "Pending",
        "Message": "string",
        "AdditionalInfo": "string"
    }
}'

Response Example

200 - Example 1

{
    "AssociationDescription": {
        "Name": "string",
        "InstanceId": "string",
        "AssociationVersion": "string",
        "Date": "string",
        "LastUpdateAssociationDate": "string",
        "Status": {
            "Date": "string",
            "Name": "Pending",
            "Message": "string",
            "AdditionalInfo": "string"
        },
        "Overview": {
            "Status": "string",
            "DetailedStatus": "string",
            "AssociationStatusAggregatedCount": {
                "property1": 0,
                "property2": 0
            }
        },
        "DocumentVersion": "string",
        "AutomationTargetParameterName": "string",
        "Parameters": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "AssociationId": "string",
        "Targets": [],
        "ScheduleExpression": "string",
        "OutputLocation": {
            "S3Location": {
                "OutputS3Region": "string",
                "OutputS3BucketName": "string",
                "OutputS3KeyPrefix": "string"
            }
        },
        "LastExecutionDate": "string",
        "LastSuccessfulExecutionDate": "string",
        "AssociationName": "string",
        "MaxErrors": "string",
        "MaxConcurrency": "string",
        "ComplianceSeverity": "CRITICAL",
        "SyncCompliance": "AUTO",
        "ApplyOnlyAtCronInterval": true,
        "CalendarNames": [],
        "TargetLocations": [],
        "ScheduleOffset": 0,
        "TargetMaps": [],
        "AlarmConfiguration": {
            "IgnorePollAlarmFailure": true,
            "Alarms": []
        },
        "TriggeredAlarms": []
    }
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480InternalServerError

🟠481InvalidInstanceId

🟠482InvalidDocument

🟠483AssociationDoesNotExist

🟠484StatusUnchanged

🟠485TooManyUpdates

Modified at 2023-08-15 10:32:33