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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#categoryString

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

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#created_byString

The ARN of the AWS account that created the OpsItem.

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#created_timeTime

The date and time the OpsItem was created.

Returns:

  • (Time)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#descriptionString

The OpsItem description.

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#last_modified_byString

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

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#last_modified_timeTime

The date and time the OpsItem was last updated.

Returns:

  • (Time)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#notificationsArray<Types::OpsItemNotification>

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

Returns:



12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  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 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.

Returns:



12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#ops_item_idString

The ID of the OpsItem.

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#priorityInteger

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

Returns:

  • (Integer)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  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:



12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#severityString

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

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  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)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  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 AWS Systems Manager User Guide.

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#titleString

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

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end

#versionString

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

Returns:

  • (String)


12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 12118

class OpsItem < Struct.new(
  :created_by,
  :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)
  include Aws::Structure
end