Creating change requests

Open the AWS Systems Manager console at https://console.aws.amazon.com/systems-manager/.

In the navigation pane, choose Change Manager.

Choose Create request.

Search for and select a change template that you want to use for this change request.

Choose Next.

For Name, enter a name for the change request that makes its purpose easy to identify, such as UpdateEC2LinuxAMI-us-east-2.

For Runbook, select the runbook you want to use to make your requested change.

For Change request information, use Markdown to provide additional information about the change request to help reviewers decide whether to approve or reject the change request. The author of the template you're using might have provided instructions or questions for you to answer.

In the Workflow start time section, choose one of the following:

In the Change request approvals section, do the following:

Choose Next.

For IAM role, select an IAM role in your current account that has the permissions needed to run the runbooks that are specified for this change request.

This role is also referred to as the service role, or assume role, for Automation. For more information about this role, see Setting up Automation.

In the Deployment location section, choose one of the following:

In the Deployment targets section, do the following:

If you chose Specify parameter values to update multiple resources in the previous step: In the Runbook parameters section, specify values for the required input parameters. The parameter values you must supply are based on the contents of the Automation runbooks associated with the change template you chose.

For example, if the change template uses the AWS-RetartEC2Instance runbook, then you must enter one or more instance IDs for the InstanceId parameter. Alternatively, choose Show interactive instance picker and select available instances one by one.

Choose Next.

In the Review and submit page, double-check the resources and options you have specified for this change request.

Choose the Edit button for any section you want to make changes to.

When you're satisfied with the change request details, choose Submit for approval.

Install and configure the AWS CLI or the AWS Tools for PowerShell, if you haven't already.

For information, see Installing or updating the latest version of the AWS CLI and Installing the AWS Tools for PowerShell.

Create a JSON file on your local machine with a name such as MyChangeRequest.json and paste the following content into it.

Replace placeholders with values for your change request.

{
    "ChangeRequestName": "MyChangeRequest",
    "DocumentName": "AWS-HelloWorldChangeTemplate",
    "DocumentVersion": "$DEFAULT",
    "ScheduledTime": "2021-12-30T03:00:00",
    "ScheduledEndTime": "2021-12-30T03:05:00",
    "Tags": [
        {
            "Key": "Purpose",
            "Value": "Testing"
        }
    ],
    "Parameters": {
        "Approver": [
            "JohnDoe"
        ],
        "ApproverType": [
            "IamUser"
        ],
        "ApproverSnsTopicArn": [
            "arn:aws:sns:us-east-2:123456789012:MyNotificationTopic"
        ]
    },
    "Runbooks": [
        {
            "DocumentName": "AWS-HelloWorld",
            "DocumentVersion": "1",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Parameters": {
                "AutomationAssumeRole": [
                    "arn:aws:iam::123456789012: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"
}

In the directory where you created the JSON file, run the following command.

aws ssm start-change-request-execution --cli-input-json file://MyChangeRequest.json

The system returns information like the following.

{
    "AutomationExecutionId": "b3c1357a-5756-4839-8617-2d2a4EXAMPLE"
}