Class: Aws::SSM::Types::OpsItem

Inherits:

Struct

Object
Struct
Aws::SSM::Types::OpsItem

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ssm/types.rb

Overview

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 [Amazon Web Services Systems Manager OpsCenter] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#actual_end_time ⇒ Time

The time a runbook workflow ended.
#actual_start_time ⇒ Time

The time a runbook workflow started.
#category ⇒ String

An OpsItem category.
#created_by ⇒ String

The ARN of the Amazon Web Services account that created the OpsItem.
#created_time ⇒ Time

The date and time the OpsItem was created.
#description ⇒ String

The OpsItem description.
#last_modified_by ⇒ String

The ARN of the Amazon Web Services account that last updated the OpsItem.
#last_modified_time ⇒ Time

The date and time the OpsItem was last updated.
#notifications ⇒ Array<Types::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.
#operational_data ⇒ Hash<String,Types::OpsItemDataValue>

Operational data is custom data that provides useful reference details about the OpsItem.
#ops_item_arn ⇒ String

The OpsItem Amazon Resource Name (ARN).
#ops_item_id ⇒ String

The ID of the OpsItem.
#ops_item_type ⇒ String

The type of OpsItem.
#planned_end_time ⇒ Time

The time specified in a change request for a runbook workflow to end.
#planned_start_time ⇒ Time

The time specified in a change request for a runbook workflow to start.
#priority ⇒ Integer

The importance of this OpsItem in relation to other OpsItems in the system.
#related_ops_items ⇒ Array<Types::RelatedOpsItem>

One or more OpsItems that share something in common with the current OpsItem.
#severity ⇒ String

The severity of the OpsItem.
#source ⇒ String

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
#status ⇒ String

The OpsItem status.
#title ⇒ String

A short heading that describes the nature of the OpsItem and the impacted resource.
#version ⇒ String

The version of this OpsItem.

Instance Attribute Details

#actual_end_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#actual_start_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#category ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_by ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_time ⇒ `Time`

The date and time the OpsItem was created.

Returns:

(Time)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The OpsItem description.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ `Time`

The date and time the OpsItem was last updated.

Returns:

(Time)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notifications ⇒ `Array<Types::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.

Returns:

(Array<Types::OpsItemNotification>)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#operational_data ⇒ `Hash<String,Types::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.

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*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html

Returns:

(Hash<String,Types::OpsItemDataValue>)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_arn ⇒ `String`

The OpsItem Amazon Resource Name (ARN).

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_id ⇒ `String`

The ID of the OpsItem.

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_type ⇒ `String`

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/insight`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#planned_end_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#planned_start_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#related_ops_items ⇒ `Array<Types::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.

Returns:

(Array<Types::RelatedOpsItem>)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The OpsItem status. For more information, see [Editing OpsItem details] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ssm/types.rb', line 13867

class OpsItem < Struct.new(
  :created_by,
  :ops_item_type,
  :created_time,
  :description,
  :last_modified_by,
  :last_modified_time,
  :notifications,
  :priority,
  :related_ops_items,
  :status,
  :ops_item_id,
  :version,
  :title,
  :source,
  :operational_data,
  :category,
  :severity,
  :actual_start_time,
  :actual_end_time,
  :planned_start_time,
  :planned_end_time,
  :ops_item_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SSM::Types::OpsItem

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#actual_end_time ⇒ Time

#actual_start_time ⇒ Time

#category ⇒ String

#created_by ⇒ String

#created_time ⇒ Time

#description ⇒ String

#last_modified_by ⇒ String

#last_modified_time ⇒ Time

#notifications ⇒ Array<Types::OpsItemNotification>

#operational_data ⇒ Hash<String,Types::OpsItemDataValue>

#ops_item_arn ⇒ String

#ops_item_id ⇒ String

#ops_item_type ⇒ String

#planned_end_time ⇒ Time

#planned_start_time ⇒ Time

#priority ⇒ Integer

#related_ops_items ⇒ Array<Types::RelatedOpsItem>

#severity ⇒ String

#source ⇒ String

#status ⇒ String

#title ⇒ String

#version ⇒ String

#actual_end_time ⇒ `Time`

#actual_start_time ⇒ `Time`

#category ⇒ `String`

#created_by ⇒ `String`

#created_time ⇒ `Time`

#description ⇒ `String`

#last_modified_by ⇒ `String`

#last_modified_time ⇒ `Time`

#notifications ⇒ `Array<Types::OpsItemNotification>`

#operational_data ⇒ `Hash<String,Types::OpsItemDataValue>`

#ops_item_arn ⇒ `String`

#ops_item_id ⇒ `String`

#ops_item_type ⇒ `String`

#planned_end_time ⇒ `Time`

#planned_start_time ⇒ `Time`

#priority ⇒ `Integer`

#related_ops_items ⇒ `Array<Types::RelatedOpsItem>`

#severity ⇒ `String`

#source ⇒ `String`

#status ⇒ `String`

#title ⇒ `String`

#version ⇒ `String`