ssm/aws.sdk.kotlin.services.ssm.model/OpsItem

OpsItem

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.

Types

object Companion

Properties

val actualEndTime: Instant?

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

actualStartTime

val actualStartTime: Instant?

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

val category: String?

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

val createdBy: String?

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

val createdTime: Instant?

The date and time the OpsItem was created.

val description: String?

The OpsItem description.

val lastModifiedBy: String?

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

lastModifiedTime

val lastModifiedTime: Instant?

The date and time the OpsItem was last updated.

val notifications: List<OpsItemNotification>?

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.

operationalData

val operationalData: Map<String, OpsItemDataValue>?

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.

val opsItemArn: String?

The OpsItem Amazon Resource Name (ARN).

val opsItemId: String?

The ID of the OpsItem.

val opsItemType: String?

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

val plannedEndTime: Instant?

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

plannedStartTime

val plannedStartTime: Instant?

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

val priority: Int?

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

relatedOpsItems

val relatedOpsItems: List<RelatedOpsItem>?

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.

val severity: String?

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

val source: String?

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

val status: OpsItemStatus?

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.

val title: String?

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

val version: String?

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

Functions

inline fun copy(block: OpsItem.Builder.() -> Unit = {}): OpsItem

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String