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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#category ⇒ String

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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_by ⇒ String

The ARN of the AWS account that created the OpsItem.

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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_time ⇒ Time

The date and time the OpsItem was created.

Returns:

  • (Time) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#description ⇒ String

The OpsItem description.

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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_by ⇒ String

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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_time ⇒ Time

The date and time the OpsItem was last updated.

Returns:

  • (Time) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#notifications ⇒ Array<Types::OpsItemNotification>

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

Returns:



11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

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

Returns:



11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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_id ⇒ String

The ID of the OpsItem.

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#priority ⇒ Integer

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

Returns:

  • (Integer) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

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



11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#severity ⇒ String

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#source ⇒ String

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#status ⇒ String

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

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#title ⇒ String

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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

#version ⇒ String

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

Returns:

  • (String) 


11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/aws-sdk-ssm/types.rb', line 11729

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