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

Inherits:
Struct
  • Object
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 [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

Instance Attribute Details

#actual_end_timeTime

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

Returns:

  • (Time)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#actual_start_timeTime

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

Returns:

  • (Time)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#categoryString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_byString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_timeTime

The date and time the OpsItem was created.

Returns:

  • (Time)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The OpsItem description.

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_byString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

The date and time the OpsItem was last updated.

Returns:

  • (Time)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#notificationsArray<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:


14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#operational_dataHash<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-creating-OpsItems.html#OpsCenter-manually-create-OpsItems

Returns:


14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_idString

The ID of the OpsItem.

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#ops_item_typeString

The type of OpsItem. Currently, the only valid values are `/aws/changerequest` and `/aws/issue`.

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#planned_end_timeTime

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

Returns:

  • (Time)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#planned_start_timeTime

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

Returns:

  • (Time)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

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

Returns:

  • (Integer)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

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:


14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#severityString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#sourceString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

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

Returns:

  • (String)

14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
# File 'lib/aws-sdk-ssm/types.rb', line 14324

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)
  SENSITIVE = []
  include Aws::Structure
end