Documentation

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with Amazon Web Services resources from a single console.

To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the Amazon Web Services resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the Amazon Web Services resource, OpsCenter aggregates information from Config, CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.

See: newOpsItem smart constructor.

Create a value of OpsItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:actualEndTime:OpsItem', opsItem_actualEndTime - The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

$sel:actualStartTime:OpsItem', opsItem_actualStartTime - The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

$sel:category:OpsItem', opsItem_category - An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

$sel:createdBy:OpsItem', opsItem_createdBy - The ARN of the Amazon Web Services account that created the OpsItem.

$sel:createdTime:OpsItem', opsItem_createdTime - The date and time the OpsItem was created.

$sel:description:OpsItem', opsItem_description - The OpsItem description.

$sel:lastModifiedBy:OpsItem', opsItem_lastModifiedBy - The ARN of the Amazon Web Services account that last updated the OpsItem.

$sel:lastModifiedTime:OpsItem', opsItem_lastModifiedTime - The date and time the OpsItem was last updated.

$sel:notifications:OpsItem', opsItem_notifications - The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.

$sel:operationalData:OpsItem', opsItem_operationalData - Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

$sel:opsItemArn:OpsItem', opsItem_opsItemArn - The OpsItem Amazon Resource Name (ARN).

OpsItem, opsItem_opsItemId - The ID of the OpsItem.

$sel:opsItemType:OpsItem', opsItem_opsItemType - The type of OpsItem. Systems Manager supports the following types of OpsItems:

• /aws/issue

  This type of OpsItem is used for default OpsItems created by OpsCenter.

• /aws/changerequest

  This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

• /aws/insights

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

$sel:plannedEndTime:OpsItem', opsItem_plannedEndTime - The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

$sel:plannedStartTime:OpsItem', opsItem_plannedStartTime - The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

$sel:priority:OpsItem', opsItem_priority - The importance of this OpsItem in relation to other OpsItems in the system.

$sel:relatedOpsItems:OpsItem', opsItem_relatedOpsItems - One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

$sel:severity:OpsItem', opsItem_severity - The severity of the OpsItem. Severity options range from 1 to 4.

$sel:source:OpsItem', opsItem_source - The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

$sel:status:OpsItem', opsItem_status - The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

$sel:title:OpsItem', opsItem_title - A short heading that describes the nature of the OpsItem and the impacted resource.

$sel:version:OpsItem', opsItem_version - The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

The ARN of the Amazon Web Services account that created the OpsItem.

The date and time the OpsItem was created.

The OpsItem description.

The ARN of the Amazon Web Services account that last updated the OpsItem.

The date and time the OpsItem was last updated.

The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

The OpsItem Amazon Resource Name (ARN).

The ID of the OpsItem.

The type of OpsItem. Systems Manager supports the following types of OpsItems:

• /aws/issue

  This type of OpsItem is used for default OpsItems created by OpsCenter.

• /aws/changerequest

  This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

• /aws/insights

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

The importance of this OpsItem in relation to other OpsItems in the system.

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

The severity of the OpsItem. Severity options range from 1 to 4.

The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

A short heading that describes the nature of the OpsItem and the impacted resource.

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.