You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateOpsItemRequest as input to an Aws::Client method, you can use a vanilla 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

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

    Update the information about the OpsItem.

#notificationsArray<Types::OpsItemNotification>

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

Returns:

  • (Array<Types::OpsItemNotification>)

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

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

  • (Hash<String,Types::OpsItemDataValue>)

    Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

#operational_data_to_deleteArray<String>

Keys that you want to remove from the OperationalData map.

Returns:

  • (Array<String>)

    Keys that you want to remove from the OperationalData map.

#ops_item_idString

The ID of the OpsItem.

Returns:

  • (String)

    The ID of the OpsItem.

#priorityInteger

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

Returns:

  • (Integer)

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

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:

  • (Array<Types::RelatedOpsItem>)

    One or more OpsItems that share something in common with the current OpsItems.

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

    The OpsItem status.

#titleString

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

Returns:

  • (String)

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