Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141381,185842.7 KB

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.

post/#X-Amz-Target=AmazonSSM.StartChangeRequestExecution

Headers

X-Amz-Target'AmazonSSM.StartChangeRequestExecution' required

Request body

ScheduledTimestring date-time
<p>The date and time specified in the change request to run the Automation runbooks.</p> <note> <p>The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.</p> </note>
DocumentNamestring required

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

DocumentVersionstring

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

Parametersobject

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

ChangeRequestNamestring

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

ClientTokenstring

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

AutoApproveboolean
<p>Indicates whether the change request can be approved automatically without the need for manual approvals.</p> <p>If <code>AutoApprovable</code> is enabled in a change template, then setting <code>AutoApprove</code> to <code>true</code> in <code>StartChangeRequestExecution</code> creates a change request that bypasses approver review.</p> <note> <p>Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is <code>CLOSED</code>, change freeze approvers must still grant permission for this change request to run. If they don't, the change won't be processed until the calendar state is again <code>OPEN</code>. </p> </note>
ScheduledEndTimestring date-time

The time that the requester expects the runbook workflow related to the change request to complete. The time is an estimate only that the requester provides for reviewers.

ChangeDetailsstring

User-provided details about the change. If no details are provided, content specified in the <b>Template information</b> section of the associated change template is added.

Response

Success

AutomationExecutionIdstring

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