Class: Aws::SSM::Types::UpdateOpsItemRequest

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

Overview

Note:

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

Instance Attribute Details

#categoryString

Specify a new category for an OpsItem.

Returns:

  • (String)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

#descriptionString

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Returns:

  • (String)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

#notificationsArray<Types::OpsItemNotification>

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

Returns:



17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

Returns:



17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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_deleteArray<String>

Keys that you want to remove from the OperationalData map.

Returns:

  • (Array<String>)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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_idString

The ID of the OpsItem.

Returns:

  • (String)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

#priorityInteger

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

Returns:

  • (Integer)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

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.

Returns:



17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

#severityString

Specify a new severity for an OpsItem.

Returns:

  • (String)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

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


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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

#titleString

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

Returns:

  • (String)


17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17311

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