Remediate OpsItem issues - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Remediate OpsItem issues

Using Amazon Systems Manager Automation runbooks, you can remediate issues with Amazon resources that are identified in an OpsItem. Automation uses predefined runbooks to remediate common issues with Amazon resources.

Each OpsItem includes the Runbooks section that provides a list of runbooks that you can use for remediation. When you choose an Automation runbook from the list, OpsCenter automatically displays some of the fields required to run the document. When you run an Automation runbook, the system associates the runbook with the related resource of the OpsItem. If Amazon EventBridge creates an OpsItem, it associates a runbook with the OpsItem. OpsCenter keeps a 30-day record of Automation runbooks for an OpsItem.

You can choose a status to view important details about the runbook, such as the reason why an automation failed and which step of the Automation runbook was running when the failure occurred, as shown in the following example.


                Status information for the last time an Automation runbook was run.

The Related resource details page for a selected OpsItem includes the Run automation list. You can choose recent or resource-specific Automation runbooks and run them to remediate issues. This page also includes data providers, including Amazon CloudWatch metrics and alarms, Amazon CloudTrail logs, and details from Amazon Config.


                List of available Automation runbooks you can run and metrics available on
                    the Related Resources tab.

You can view information about an Automation runbook by either choosing its name in the console or by using the Systems Manager Automation runbook reference.

Remediating an OpsItem using a runbook

Before you use an Automation runbook to remediate an OpsItem issue, do the following:

  • Verify that you have permission to run Systems Manager Automation runbooks. For more information, see Setting up Automation.

  • Collect resource-specific ID information for the automation that you want to run. For example, if you want to run an automation that restarts an EC2 instance, then you must specify the ID of the EC2 instance to restart.

To run an Automation runbook to remediate an OpsItem issue
  1. Open the Amazon Systems Manager console at https://console.amazonaws.cn/systems-manager/.

  2. In the navigation pane, choose OpsCenter.

  3. Choose the OpsItem ID to open the details page.

    
                            A new OpsItem on the OpsCenter Overview page.
  4. Scroll to the Runbooks section.

  5. Use the search bar or the numbers in the upper right to find the Automation runbook that you want to run.

  6. Choose a runbook, and then choose Execute.

  7. Enter the required information for the runbook, and then choose Submit.

    Once you start the runbook, the system returns to the previous screen and displays the status.

  8. In the Automation executions in the last 30 days section, choose the Execution ID link to view steps and the status of the execution.

Remediating an OpsItem using an associated runbook

After you run an Automation runbook from an OpsItem, OpsCenter associates the runbook with the OpsItem. An associated runbook is ranked higher than other runbooks in the Runbooks list.

Use the following procedure to run an Automation runbook that has already been associated with a related resource in an OpsItem. For information about adding related resources, see Manage OpsItems.

To run a resource-associated runbook to remediate an OpsItem issue
  1. Open the Amazon Systems Manager console at https://console.amazonaws.cn/systems-manager/.

  2. In the navigation pane, choose OpsCenter.

  3. Open the OpsItem.

  4. In the Related resources section, choose the resource on which you want to run the Automation runbook.

  5. Choose Run automation, and then choose the associated Automation runbook that you want to run.

  6. Enter the required information for the runbook, and then choose Execute.

    Once you start the runbook, the system returns to the previous screen and displays the status.

  7. In the Automation executions in the last 30 days section, choose the Execution ID link to view steps and the status of the execution.