Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

StartChangeRequestExecution

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 Syntax


{
   "AutoApprove": boolean,
   "ChangeDetails": "string",
   "ChangeRequestName": "string",
   "ClientToken": "string",
   "DocumentName": "string",
   "DocumentVersion": "string",
   "Parameters": { 
      "string" : [ "string" ]
   },
   "Runbooks": [ 
      { 
         "DocumentName": "string",
         "DocumentVersion": "string",
         "MaxConcurrency": "string",
         "MaxErrors": "string",
         "Parameters": { 
            "string" : [ "string" ]
         },
         "TargetLocations": [ 
            { 
               "Accounts": [ "string" ],
               "ExcludeAccounts": [ "string" ],
               "ExecutionRoleName": "string",
               "IncludeChildOrganizationUnits": boolean,
               "Regions": [ "string" ],
               "TargetLocationAlarmConfiguration": { 
                  "Alarms": [ 
                     { 
                        "Name": "string"
                     }
                  ],
                  "IgnorePollAlarmFailure": boolean
               },
               "TargetLocationMaxConcurrency": "string",
               "TargetLocationMaxErrors": "string",
               "Targets": [ 
                  { 
                     "Key": "string",
                     "Values": [ "string" ]
                  }
               ],
               "TargetsMaxConcurrency": "string",
               "TargetsMaxErrors": "string"
            }
         ],
         "TargetMaps": [ 
            { 
               "string" : [ "string" ]
            }
         ],
         "TargetParameterName": "string",
         "Targets": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ]
      }
   ],
   "ScheduledEndTime": number,
   "ScheduledTime": number,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AutoApprove

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.

Note

Change Calendar restrictions are not bypassed in this scenario. If the state of an associated calendar is CLOSED, 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 OPEN.

Type: Boolean

Required: No

ChangeDetails

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32768.

Required: No

ChangeRequestName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

ClientToken

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

Type: String

Length Constraints: Fixed length of 36.

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}

Required: No

DocumentName

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

Type: String

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

Required: Yes

DocumentVersion

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

Type: String

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

Required: No

Parameters

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

Type: String to array of strings map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

Runbooks

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

Note

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Type: Array of Runbook objects

Array Members: Fixed number of 1 item.

Required: Yes

ScheduledEndTime

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.

Type: Timestamp

Required: No

ScheduledTime

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

Note

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

Type: Timestamp

Required: No

Tags

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:

Key=Environment,Value=Production
Key=Region,Value=us-east-2

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

Response Syntax


{
   "AutomationExecutionId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AutomationExecutionId

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

Type: String

Length Constraints: Fixed length of 36.

Errors

For information about the errors that are common to all actions, see Common Errors.

AutomationDefinitionNotApprovedException

Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.

HTTP Status Code: 400

AutomationDefinitionNotFoundException

An Automation runbook with the specified name couldn't be found.

HTTP Status Code: 400

AutomationDefinitionVersionNotFoundException

An Automation runbook with the specified name and version couldn't be found.

HTTP Status Code: 400

AutomationExecutionLimitExceededException

The number of simultaneously running Automation executions exceeded the allowable limit.

HTTP Status Code: 400

IdempotentParameterMismatch

Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

HTTP Status Code: 400

InternalServerError

An error occurred on the server side.

HTTP Status Code: 500

InvalidAutomationExecutionParametersException

The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of StartChangeRequestExecution.

Sample Request


POST / HTTP/1.1
Host: ssm.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonSSM.StartChangeRequestExecution
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.12 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ssm.start-change-request-execution
X-Amz-Date: 20240820T192759Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20240820/us-east-2/ssm/aws4_request, 
SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 1247

{
    "ChangeRequestName": "MyChangeRequest",
    "DocumentName": "AWS-HelloWorldChangeTemplate",
    "DocumentVersion": "$DEFAULT",
    "ScheduledTime": 1640833200,
    "ScheduledEndTime": 1640833500,
    "Tags": [
        {
            "Key": "Purpose",
            "Value": "Testing"
        }
    ],
    "Parameters": {
        "Approver": [
            "JohnDoe"
        ],
        "ApproverType": [
            "IamUser"
        ],
        "ApproverSnsTopicArn": [
            "arn:aws:sns:us-east-2:111122223333:MyNotificationTopic"
        ]
    },
    "Runbooks": [
        {
            "DocumentName": "AWS-HelloWorld",
            "DocumentVersion": "1",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Parameters": {
                "AutomationAssumeRole": [
                    "arn:aws:iam::111122223333:role/MyChangeManagerAssumeRole"
                ]
            }
        }
    ],
    "ChangeDetails": "### Document Name: HelloWorldChangeTemplate\n\n## What does this document do?\nThis change template demonstrates the feature set available for creating change templates for Change Manager. This template starts a Runbook workflow for the Automation document called AWS-HelloWorld.\n\n## Input Parameters\n* ApproverSnsTopicArn: (Required) Amazon Simple Notification Service ARN for approvers.\n* Approver: (Required) The name of the approver to send this request to.\n* ApproverType: (Required) The type of reviewer.\n  * Allowed Values: IamUser, IamGroup, IamRole, SSOGroup, SSOUser\n\n## Output Parameters\nThis document has no outputs \n"
}

Sample Response


{
    "AutomationExecutionId": "dddd1c6c-849d-4ee0-acc1-0be9dEXAMPLE"
}