v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141381,185842.7 KB

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.

post/#X-Amz-Target=AmazonSSM.UpdateOpsItem

Headers

X-Amz-Target'AmazonSSM.UpdateOpsItem' required

Request body

Descriptionstring

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

OperationalDataobject
<p>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.</p> <p>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.</p> <important> <p>Operational data keys <i>can't</i> begin with the following: <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>, <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p> </important> <p>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 <a>DescribeOpsItems</a> 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 <a>GetOpsItem</a> API operation).</p> <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in the request. Use the <code>/aws/automations</code> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
OperationalDataToDeleteString[]

Keys that you want to remove from the OperationalData map.

Priorityinteger

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

Status'Open' | 'InProgress' | 'Resolved' | 'Pending' | 'TimedOut' | 'Cancelling' | 'Cancelled' | 'Failed' | 'CompletedWithSuccess' | 'CompletedWithFailure' | 'Scheduled' | 'RunbookInProgress' | 'PendingChangeCalendarOverride' | 'ChangeCalendarOverrideApproved' | 'ChangeCalendarOverrideRejected' | 'PendingApproval' | 'Approved' | 'Rejected' | 'Closed'

The OpsItem status. Status can be <code>Open</code>, <code>In Progress</code>, or <code>Resolved</code>. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.

OpsItemIdstring required

The ID of the OpsItem.

Titlestring

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

Categorystring

Specify a new category for an OpsItem.

Severitystring

Specify a new severity for an OpsItem.

ActualStartTimestring date-time

The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.

ActualEndTimestring date-time

The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.

PlannedStartTimestring date-time

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.

PlannedEndTimestring date-time

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.

OpsItemArnstring

The OpsItem Amazon Resource Name (ARN).

Response

Success

UpdateOpsItemResponse required