Sign in

v1

latestOpenAPI 3.0.0CoreStack Inc License2026-07-248001,5071.7 MB
AwsSsm Command

Execute command document

Execute a command document with all required parameters

post/v1/runbook/{tenant_id}/AWS/command/{document_id}

Request body

cloud_account_idstring required

Cloud Account id for which command document need to be executed.

regionstring required

Region of the document to be executed.

document_namestring required

Name of the document.

document_versionstring required

The SSM document version to use in the request.

document_hashstring

The cryptographic hash value of the document content.

document_hash_type'Sha256' | 'Sha1'

The hash algorithm used to calculate the hash value

parametersobject

The required and optional parameters specified in the document being run.

max_concurrencystring

The maximum number of managed nodes that are allowed to run the command at the same time.

max_errorsstring

The maximum number of errors allowed without the command failing.

change_idstring

Service Now tracking id

instance_idsstring[]

The IDs of the managed nodes where the command should run.

timeout_secondsinteger

If this time is reached and the command has not already started running, it wont run.

commentstring

User-specified information about the command.

output_s3_bucket_namestring

The name of the S3 bucket where command execution responses should be stored.

output_s3_key_prefixstring

The directory structure within the S3 bucket where the responses should be stored.

service_role_arnstring

The ARN of the AWS IAM service role to use to publish Amazon SNS notifications for Run Command commands.

Example request

{
  "document_hash_type": "Sha256",
  "notification_config": {
    "events": [
      "All"
    ],
    "notification_type": "Command"
  }
}

Response

Created

execution_idstring

Automation Execution Id