Systems Manager Ops Item

This table represents the Systems Manager Ops Item resource from Amazon Web Services.

aws.ssm_opsitem

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
actual_end_timecoretimestampThe time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.
actual_start_timecoretimestampThe time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.
categorycorestringAn OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
created_bycorestringThe ARN of the Amazon Web Services account that created the OpsItem.
created_timecoretimestampThe date and time the OpsItem was created.
descriptioncorestringThe OpsItem description.
last_modified_bycorestringThe ARN of the Amazon Web Services account that last updated the OpsItem.
last_modified_timecoretimestampThe date and time the OpsItem was last updated.
notificationscorejsonThe Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
operational_datacorestringOperational 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. <important> 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>. </important> 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). 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-manually-create-OpsItems.html">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.
ops_item_arncorestringThe OpsItem Amazon Resource Name (ARN).
ops_item_idcorestringThe ID of the OpsItem.
ops_item_typecorestringThe type of OpsItem. Systems Manager supports the following types of OpsItems: <ul> <li> <code>/aws/issue</code> This type of OpsItem is used for default OpsItems created by OpsCenter. </li> <li> <code>/aws/changerequest</code> This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests. </li> <li> <code>/aws/insight</code> This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems. </li> </ul>
planned_end_timecoretimestampThe time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.
planned_start_timecoretimestampThe time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.
prioritycoreint64The importance of this OpsItem in relation to other OpsItems in the system.
related_ops_itemscorejsonOne or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
severitycorestringThe severity of the OpsItem. Severity options range from 1 to 4.
statuscorestringThe OpsItem status. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.
tagscorehstore
titlecorestringA short heading that describes the nature of the OpsItem and the impacted resource.
versioncorestringThe version of this OpsItem. Each time the OpsItem is edited the version number increments by one.