/

The Amazon SSM multi-region endpoint

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

POST

Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.

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 '{
    "ScheduledTime": "string",
    "DocumentName": "string",
    "DocumentVersion": "string",
    "Parameters": {
        "property1": [
            "string"
        ],
        "property2": [
            "string"
        ]
    },
    "ChangeRequestName": "string",
    "ClientToken": "string",
    "AutoApprove": true,
    "Runbooks": [],
    "Tags": [],
    "ScheduledEndTime": "string",
    "ChangeDetails": "string"
}'

Response Example

200 - Example 1

{
    "AutomationExecutionId": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

ScheduledTime

string <date-time>

optional

The date and time specified in the change request to run the Automation runbooks.

DocumentName

string

required

The name of the change template document to run during the runbook workflow.

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

DocumentVersion

string

optional

The version of the change template document to run during the runbook workflow.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Parameters

object

optional

A key-value map of parameters that match the declared parameters in the change template document.

ChangeRequestName

string

optional

The name of the change request associated with the runbook workflow to be run.

>= 1 characters<= 1024 characters

ClientToken

string

optional

The user-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

>= 36 characters<= 36 characters

Match pattern:

[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

AutoApprove

boolean

optional

Indicates whether the change request can be approved automatically without the need for manual approvals.

If AutoApprovable is enabled in a change template, then setting AutoApprove to true in StartChangeRequestExecution creates a change request that bypasses approver review.

Runbooks

array[object (Runbook) {9}]

required

Information about the Automation runbooks that are run during the runbook workflow.

>= 1 items<= 1 items

DocumentName

string

required

The name of the Automation runbook used in a runbook workflow.

Match pattern:

^[a-zA-Z0-9_\-.:/]{3,128}$

DocumentVersion

string

optional

The version of the Automation runbook used in a runbook workflow.

Match pattern:

([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

Parameters

object

optional

The key-value map of execution parameters, which were supplied when calling StartChangeRequestExecution.

TargetParameterName

string

optional

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify Targets.

>= 1 characters<= 50 characters

Targets

array [object]

optional

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify TargetParameterName.

>= 0 items<= 5 items

TargetMaps

array[object (TargetMap)]

optional

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

>= 0 items<= 300 items

MaxConcurrency

string

optional

The MaxConcurrency value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$

MaxErrors

string

optional

The MaxErrors value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

>= 1 characters<= 7 characters

Match pattern:

^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$

TargetLocations

array[object (TargetLocation) {6}]

optional

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

>= 1 items<= 100 items

Responses

🟢200Success

application/json

Body

AutomationExecutionId

string

optional

The unique ID of a runbook workflow operation. (A runbook workflow is a type of Automation operation.)

>= 36 characters<= 36 characters

🟠480AutomationDefinitionNotFoundException

🟠481InvalidAutomationExecutionParametersException

🟠482AutomationExecutionLimitExceededException

🟠483AutomationDefinitionVersionNotFoundException

🟠484IdempotentParameterMismatch

🟠485InternalServerError

🟠486AutomationDefinitionNotApprovedException