/

The Amazon SSM multi-region endpoint

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

POST

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

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",
    "DocumentVersion": "string",
    "InstanceId": "string",
    "Parameters": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "Targets": [],
    "ScheduleExpression": "string",
    "OutputLocation": {
        "S3Location": {
            "OutputS3Region": "string",
            "OutputS3BucketName": "string",
            "OutputS3KeyPrefix": "string"
        }
    },
    "AssociationName": "string",
    "AutomationTargetParameterName": "string",
    "MaxErrors": "string",
    "MaxConcurrency": "string",
    "ComplianceSeverity": "CRITICAL",
    "SyncCompliance": "AUTO",
    "ApplyOnlyAtCronInterval": true,
    "CalendarNames": [],
    "TargetLocations": [],
    "ScheduleOffset": 0,
    "TargetMaps": [],
    "Tags": [],
    "AlarmConfiguration": {
        "IgnorePollAlarmFailure": true,
        "Alarms": []
    }
}'

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

🟠480AssociationAlreadyExists

🟠481AssociationLimitExceeded

🟠482InternalServerError

🟠483InvalidDocument

🟠484InvalidDocumentVersion

🟠485InvalidInstanceId

🟠486UnsupportedPlatformType

🟠487InvalidOutputLocation

🟠488InvalidParameters

🟠489InvalidTarget

🟠490InvalidSchedule

🟠491InvalidTargetMaps

🟠492InvalidTag

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