Class: Aws::SSM::Types::UpdateOpsItemRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::UpdateOpsItemRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
When making an API call, you may pass UpdateOpsItemRequest data as a hash:
{
description: "OpsItemDescription",
operational_data: {
"OpsItemDataKey" => {
value: "OpsItemDataValueString",
type: "SearchableString", # accepts SearchableString, String
},
},
operational_data_to_delete: ["String"],
notifications: [
{
arn: "String",
},
],
priority: 1,
related_ops_items: [
{
ops_item_id: "String", # required
},
],
status: "Open", # accepts Open, InProgress, Resolved
ops_item_id: "OpsItemId", # required
title: "OpsItemTitle",
category: "OpsItemCategory",
severity: "OpsItemSeverity",
}
Instance Attribute Summary collapse
-
#category ⇒ String
Specify a new category for an OpsItem.
-
#description ⇒ String
Update the information about the OpsItem.
-
#notifications ⇒ Array<Types::OpsItemNotification>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
-
#operational_data ⇒ Hash<String,Types::OpsItemDataValue>
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
-
#operational_data_to_delete ⇒ Array<String>
Keys that you want to remove from the OperationalData map.
-
#ops_item_id ⇒ String
The ID of the OpsItem.
-
#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 OpsItems.
-
#severity ⇒ String
Specify a new severity for an OpsItem.
-
#status ⇒ String
The OpsItem status.
-
#title ⇒ String
A short heading that describes the nature of the OpsItem and the impacted resource.
Instance Attribute Details
#category ⇒ String
Specify a new category for an OpsItem.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#description ⇒ String
Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :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.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#operational_data ⇒ Hash<String,Types::OpsItemDataValue>
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
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*.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#operational_data_to_delete ⇒ Array<String>
Keys that you want to remove from the OperationalData map.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#ops_item_id ⇒ String
The ID of the OpsItem.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#priority ⇒ Integer
The importance of this OpsItem in relation to other OpsItems in the system.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#related_ops_items ⇒ Array<Types::RelatedOpsItem>
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#severity ⇒ String
Specify a new severity for an OpsItem.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :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*.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |
#title ⇒ String
A short heading that describes the nature of the OpsItem and the impacted resource.
16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 |
# File 'lib/aws-sdk-ssm/types.rb', line 16773 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity) include Aws::Structure end |