/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Description": "string",
    "OperationalData": {
        "property1": {
            "Value": "string",
            "Type": "SearchableString"
        }
    },
    "OperationalDataToDelete": [],
    "Notifications": [],
    "Priority": 0,
    "RelatedOpsItems": [],
    "Status": "Open",
    "OpsItemId": "string",
    "Title": "string",
    "Category": "string",
    "Severity": "string",
    "ActualStartTime": "string",
    "ActualEndTime": "string",
    "PlannedStartTime": "string",
    "PlannedEndTime": "string",
    "OpsItemArn": "string"
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Description

string

optional

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

>= 1 characters<= 2048 characters

Match pattern:

[\s\S]*\S[\s\S]*

OperationalData

object

optional

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.

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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

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 Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

OperationalDataToDelete

array[string]

optional

Keys that you want to remove from the OperationalData map.

Notifications

array[object (OpsItemNotification) {1}]

optional

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

Arn

string

optional

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

Priority

integer

optional

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

>= 1<= 5

RelatedOpsItems

array[object (RelatedOpsItem) {1}]

optional

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.

OpsItemId

string

required

The ID of an OpsItem related to the current OpsItem.

Status

enum<string>

optional

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

Allowed values:

OpenInProgressResolvedPendingTimedOutCancellingCancelledFailedCompletedWithSuccessCompletedWithFailureScheduledRunbookInProgressPendingChangeCalendarOverrideChangeCalendarOverrideApprovedChangeCalendarOverrideRejectedPendingApprovalApprovedRejectedClosed

OpsItemId

string

required

The ID of the OpsItem.

Match pattern:

^(oi)-[0-9a-f]{12}$

Title

string

optional

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

>= 1 characters<= 1024 characters

Match pattern:

^(?!\s*$).+

Responses

🟢200Success

application/json

Body

object {0}

🟠480InternalServerError

🟠481OpsItemNotFoundException

🟠482OpsItemAlreadyExistsException

🟠483OpsItemLimitExceededException

🟠484OpsItemInvalidParameterException

🟠485OpsItemAccessDeniedException