OpsItem - AWS Systems Manager

OpsItem

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

Contents

Category

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

Type: String

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

Required: No

CreatedBy

The ARN of the AWS account that created the OpsItem.

Type: String

Required: No

CreatedTime

The date and time the OpsItem was created.

Type: Timestamp

Required: No

Description

The OpsItem description.

Type: String

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

Required: No

LastModifiedBy

The ARN of the AWS account that last updated the OpsItem.

Type: String

Required: No

LastModifiedTime

The date and time the OpsItem was last updated.

Type: Timestamp

Required: No

Notifications

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

Type: Array of OpsItemNotification objects

Required: No

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.

Important

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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

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 AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.

Type: String to OpsItemDataValue object map

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

Required: No

OpsItemId

The ID of the OpsItem.

Type: String

Pattern: ^(oi)-[0-9a-f]{12}$

Required: No

Priority

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 5.

Required: No

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.

Type: Array of RelatedOpsItem objects

Required: No

Severity

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

Type: String

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

Required: No

Source

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

Type: String

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

Required: No

Status

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

Type: String

Valid Values: Open | InProgress | Resolved

Required: No

Title

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

Type: String

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

Required: No

Version

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: