/

The Amazon SSM multi-region endpoint

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

POST

Runs commands on one or more managed nodes.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480DuplicateInstanceId

🟠481InternalServerError

🟠482InvalidInstanceId

🟠483InvalidDocument

🟠484InvalidDocumentVersion

🟠485InvalidOutputFolder

🟠486InvalidParameters

🟠487UnsupportedPlatformType

🟠488MaxDocumentSizeExceeded

🟠489InvalidRole

🟠490InvalidNotificationConfig

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 '{
    "InstanceIds": [],
    "Targets": [],
    "DocumentName": "string",
    "DocumentVersion": "string",
    "DocumentHash": "string",
    "DocumentHashType": "Sha256",
    "TimeoutSeconds": 0,
    "Comment": "string",
    "Parameters": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "OutputS3Region": "string",
    "OutputS3BucketName": "string",
    "OutputS3KeyPrefix": "string",
    "MaxConcurrency": "string",
    "MaxErrors": "string",
    "ServiceRoleArn": "string",
    "NotificationConfig": {
        "NotificationArn": "string",
        "NotificationEvents": [],
        "NotificationType": "Command"
    },
    "CloudWatchOutputConfig": {
        "CloudWatchLogGroupName": "string",
        "CloudWatchOutputEnabled": true
    },
    "AlarmConfiguration": {
        "IgnorePollAlarmFailure": true,
        "Alarms": []
    }
}'

Response Example

200 - Example 1

{
    "Command": {
        "CommandId": "string",
        "DocumentName": "string",
        "DocumentVersion": "string",
        "Comment": "string",
        "ExpiresAfter": "string",
        "Parameters": {
            "property1": [
                "string"
            ],
            "property2": [
                "string"
            ]
        },
        "InstanceIds": [],
        "Targets": [],
        "RequestedDateTime": "string",
        "Status": "Pending",
        "StatusDetails": "string",
        "OutputS3Region": "string",
        "OutputS3BucketName": "string",
        "OutputS3KeyPrefix": "string",
        "MaxConcurrency": "string",
        "MaxErrors": "string",
        "TargetCount": 0,
        "CompletedCount": 0,
        "ErrorCount": 0,
        "DeliveryTimedOutCount": 0,
        "ServiceRole": "string",
        "NotificationConfig": {
            "NotificationArn": "string",
            "NotificationEvents": [],
            "NotificationType": "Command"
        },
        "CloudWatchOutputConfig": {
            "CloudWatchLogGroupName": "string",
            "CloudWatchOutputEnabled": true
        },
        "TimeoutSeconds": 0,
        "AlarmConfiguration": {
            "IgnorePollAlarmFailure": true,
            "Alarms": []
        },
        "TriggeredAlarms": []
    }
}

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