Execute automation document

post

https://api.corestack.io/v1/runbook/{tenant_id}/AWS/automation/{document_id}

Execute a automation document with all required parameters

Path Params

tenant_id

string

required

document_id

string

required

Body Params

cloud_account_id

string

required

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

region

string

required

Region of the document to be executed.

document_name

string

required

Name of the document.

document_version

string

required

The SSM document version to use in the request.

document_hash

string

The cryptographic hash value of the document content.

document_hash_type

string

enum

The hash algorithm used to calculate the hash value

Allowed:

parameters

object

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

max_concurrency

string

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

max_errors

string

The maximum number of errors allowed without the command failing.

alarm_configuration

object

change_id

string

Service Now tracking id

client_token

string

Client auth token.

mode

string

Execution mode of the document.

target_parameter_name

string

The name of the parameter used as the target resource for the rate-controlled execution.

targets

array of objects

An array of search criteria that targets managed nodes using a Key,Value combination.

targets

target_maps

object

A key-value mapping of document parameters to target resources.

target_locations

array of objects

A location is a combination of AWS Regions and/or AWS accounts.

target_locations

200Created

400Bad Request

401Unauthorized

500Internal Server Error