CREATEOPSITEM()`¶

About CreateOpsItem¶

Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up 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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Method Signature¶

METHODS /AWS1/IF_SSM~CREATEOPSITEM
  IMPORTING
    !IV_DESCRIPTION TYPE /AWS1/SSMOPSITEMDESCRIPTION OPTIONAL
    !IV_OPSITEMTYPE TYPE /AWS1/SSMOPSITEMTYPE OPTIONAL
    !IT_OPERATIONALDATA TYPE /AWS1/CL_SSMOPSITEMDATAVALUE=>TT_OPSITEMOPERATIONALDATA OPTIONAL
    !IT_NOTIFICATIONS TYPE /AWS1/CL_SSMOPSITEMNOTIF=>TT_OPSITEMNOTIFICATIONS OPTIONAL
    !IV_PRIORITY TYPE /AWS1/SSMOPSITEMPRIORITY OPTIONAL
    !IT_RELATEDOPSITEMS TYPE /AWS1/CL_SSMRELATEDOPSITEM=>TT_RELATEDOPSITEMS OPTIONAL
    !IV_SOURCE TYPE /AWS1/SSMOPSITEMSOURCE OPTIONAL
    !IV_TITLE TYPE /AWS1/SSMOPSITEMTITLE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST OPTIONAL
    !IV_CATEGORY TYPE /AWS1/SSMOPSITEMCATEGORY OPTIONAL
    !IV_SEVERITY TYPE /AWS1/SSMOPSITEMSEVERITY OPTIONAL
    !IV_ACTUALSTARTTIME TYPE /AWS1/SSMDATETIME OPTIONAL
    !IV_ACTUALENDTIME TYPE /AWS1/SSMDATETIME OPTIONAL
    !IV_PLANNEDSTARTTIME TYPE /AWS1/SSMDATETIME OPTIONAL
    !IV_PLANNEDENDTIME TYPE /AWS1/SSMDATETIME OPTIONAL
    !IV_ACCOUNTID TYPE /AWS1/SSMOPSITEMACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmcreateopsitemrsp
  RAISING
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMOPSITEMACCDENIEDEX
    /AWS1/CX_SSMOPSITEMALRDYEXEX
    /AWS1/CX_SSMOPSITEMINVPARAMEX
    /AWS1/CX_SSMOPSITEMLIMITEXCDEX
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_description` `TYPE /AWS1/SSMOPSITEMDESCRIPTION` `/AWS1/SSMOPSITEMDESCRIPTION`¶

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.

`iv_source` `TYPE /AWS1/SSMOPSITEMSOURCE` `/AWS1/SSMOPSITEMSOURCE`¶

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

The source name can't contain the following strings: aws, amazon, and amzn.

`iv_title` `TYPE /AWS1/SSMOPSITEMTITLE` `/AWS1/SSMOPSITEMTITLE`¶

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

Optional arguments:¶

`iv_opsitemtype` `TYPE /AWS1/SSMOPSITEMTYPE` `/AWS1/SSMOPSITEMTYPE`¶

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

/aws/issue

This type of OpsItem is used for default OpsItems created by OpsCenter.

/aws/insight

This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

/aws/changerequest

This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

Amazon Web Services Systems Manager Change Manager will no longer be open to new customers starting November 7, 2025. If you would like to use Change Manager, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.

`it_operationaldata` `TYPE /AWS1/CL_SSMOPSITEMDATAVALUE=>TT_OPSITEMOPERATIONALDATA` `TT_OPSITEMOPERATIONALDATA`¶

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 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 Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.

`it_notifications` `TYPE /AWS1/CL_SSMOPSITEMNOTIF=>TT_OPSITEMNOTIFICATIONS` `TT_OPSITEMNOTIFICATIONS`¶

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

`iv_priority` `TYPE /AWS1/SSMOPSITEMPRIORITY` `/AWS1/SSMOPSITEMPRIORITY`¶

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

`it_relatedopsitems` `TYPE /AWS1/CL_SSMRELATEDOPSITEM=>TT_RELATEDOPSITEMS` `TT_RELATEDOPSITEMS`¶

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.

`it_tags` `TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST` `TT_TAGLIST`¶

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

`iv_category` `TYPE /AWS1/SSMOPSITEMCATEGORY` `/AWS1/SSMOPSITEMCATEGORY`¶

Specify a category to assign to an OpsItem.

`iv_severity` `TYPE /AWS1/SSMOPSITEMSEVERITY` `/AWS1/SSMOPSITEMSEVERITY`¶

Specify a severity to assign to an OpsItem.

`iv_actualstarttime` `TYPE /AWS1/SSMDATETIME` `/AWS1/SSMDATETIME`¶

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

`iv_actualendtime` `TYPE /AWS1/SSMDATETIME` `/AWS1/SSMDATETIME`¶

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

`iv_plannedstarttime` `TYPE /AWS1/SSMDATETIME` `/AWS1/SSMDATETIME`¶

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

`iv_plannedendtime` `TYPE /AWS1/SSMDATETIME` `/AWS1/SSMDATETIME`¶

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

`iv_accountid` `TYPE /AWS1/SSMOPSITEMACCOUNTID` `/AWS1/SSMOPSITEMACCOUNTID`¶

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmcreateopsitemrsp` `/AWS1/CL_SSMCREATEOPSITEMRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createopsitem(
  it_notifications = VALUE /aws1/cl_ssmopsitemnotif=>tt_opsitemnotifications(
    ( new /aws1/cl_ssmopsitemnotif( |string| ) )
  )
  it_operationaldata = VALUE /aws1/cl_ssmopsitemdatavalue=>tt_opsitemoperationaldata(
    (
      VALUE /aws1/cl_ssmopsitemdatavalue=>ts_opsitemopaldata_maprow(
        value = new /aws1/cl_ssmopsitemdatavalue(
          iv_type = |string|
          iv_value = |string|
        )
        key = |string|
      )
    )
  )
  it_relatedopsitems = VALUE /aws1/cl_ssmrelatedopsitem=>tt_relatedopsitems(
    ( new /aws1/cl_ssmrelatedopsitem( |string| ) )
  )
  it_tags = VALUE /aws1/cl_ssmtag=>tt_taglist(
    (
      new /aws1/cl_ssmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_accountid = |string|
  iv_actualendtime = '20150101000000.0000000'
  iv_actualstarttime = '20150101000000.0000000'
  iv_category = |string|
  iv_description = |string|
  iv_opsitemtype = |string|
  iv_plannedendtime = '20150101000000.0000000'
  iv_plannedstarttime = '20150101000000.0000000'
  iv_priority = 123
  iv_severity = |string|
  iv_source = |string|
  iv_title = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_opsitemid( ).
  lv_opsitemarn = lo_result->get_opsitemarn( ).
ENDIF.

/AWS1/IF_SSM=>CREATEOPSITEM()¶

About CreateOpsItem¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_description TYPE /AWS1/SSMOPSITEMDESCRIPTION /AWS1/SSMOPSITEMDESCRIPTION¶

iv_source TYPE /AWS1/SSMOPSITEMSOURCE /AWS1/SSMOPSITEMSOURCE¶

iv_title TYPE /AWS1/SSMOPSITEMTITLE /AWS1/SSMOPSITEMTITLE¶

Optional arguments:¶

iv_opsitemtype TYPE /AWS1/SSMOPSITEMTYPE /AWS1/SSMOPSITEMTYPE¶

it_operationaldata TYPE /AWS1/CL_SSMOPSITEMDATAVALUE=>TT_OPSITEMOPERATIONALDATA TT_OPSITEMOPERATIONALDATA¶

it_notifications TYPE /AWS1/CL_SSMOPSITEMNOTIF=>TT_OPSITEMNOTIFICATIONS TT_OPSITEMNOTIFICATIONS¶

iv_priority TYPE /AWS1/SSMOPSITEMPRIORITY /AWS1/SSMOPSITEMPRIORITY¶

it_relatedopsitems TYPE /AWS1/CL_SSMRELATEDOPSITEM=>TT_RELATEDOPSITEMS TT_RELATEDOPSITEMS¶

it_tags TYPE /AWS1/CL_SSMTAG=>TT_TAGLIST TT_TAGLIST¶

iv_category TYPE /AWS1/SSMOPSITEMCATEGORY /AWS1/SSMOPSITEMCATEGORY¶

iv_severity TYPE /AWS1/SSMOPSITEMSEVERITY /AWS1/SSMOPSITEMSEVERITY¶

iv_actualstarttime TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME¶

iv_actualendtime TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME¶

iv_plannedstarttime TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME¶

iv_plannedendtime TYPE /AWS1/SSMDATETIME /AWS1/SSMDATETIME¶

iv_accountid TYPE /AWS1/SSMOPSITEMACCOUNTID /AWS1/SSMOPSITEMACCOUNTID¶