Skip to content

/AWS1/IF_SMI=>STARTINCIDENT()

About StartIncident

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Method Signature

METHODS /AWS1/IF_SMI~STARTINCIDENT
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/SMICLIENTTOKEN OPTIONAL
    !IV_RESPONSEPLANARN TYPE /AWS1/SMIARN OPTIONAL
    !IV_TITLE TYPE /AWS1/SMIINCIDENTTITLE OPTIONAL
    !IV_IMPACT TYPE /AWS1/SMIIMPACT OPTIONAL
    !IO_TRIGGERDETAILS TYPE REF TO /AWS1/CL_SMITRIGGERDETAILS OPTIONAL
    !IT_RELATEDITEMS TYPE /AWS1/CL_SMIRELATEDITEM=>TT_RELATEDITEMLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_smistartincidentout
  RAISING
    /AWS1/CX_SMIACCESSDENIEDEX
    /AWS1/CX_SMICONFLICTEXCEPTION
    /AWS1/CX_SMIINTERNALSERVEREX
    /AWS1/CX_SMIRESOURCENOTFOUNDEX
    /AWS1/CX_SMITHROTTLINGEX
    /AWS1/CX_SMIVALIDATIONEX
    /AWS1/CX_SMICLIENTEXC
    /AWS1/CX_SMISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_responseplanarn TYPE /AWS1/SMIARN /AWS1/SMIARN

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

Optional arguments:

iv_clienttoken TYPE /AWS1/SMICLIENTTOKEN /AWS1/SMICLIENTTOKEN

A token ensuring that the operation is called only once with the specified details.

iv_title TYPE /AWS1/SMIINCIDENTTITLE /AWS1/SMIINCIDENTTITLE

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

iv_impact TYPE /AWS1/SMIIMPACT /AWS1/SMIIMPACT

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

io_triggerdetails TYPE REF TO /AWS1/CL_SMITRIGGERDETAILS /AWS1/CL_SMITRIGGERDETAILS

Details of what created the incident record in Incident Manager.

it_relateditems TYPE /AWS1/CL_SMIRELATEDITEM=>TT_RELATEDITEMLIST TT_RELATEDITEMLIST

Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

RETURNING

oo_output TYPE REF TO /aws1/cl_smistartincidentout /AWS1/CL_SMISTARTINCIDENTOUT

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->startincident(
  io_triggerdetails = new /aws1/cl_smitriggerdetails(
    iv_rawdata = |string|
    iv_source = |string|
    iv_timestamp = '20150101000000.0000000'
    iv_triggerarn = |string|
  )
  it_relateditems = VALUE /aws1/cl_smirelateditem=>tt_relateditemlist(
    (
      new /aws1/cl_smirelateditem(
        io_identifier = new /aws1/cl_smiitemidentifier(
          io_value = new /aws1/cl_smiitemvalue(
            io_pagerdutyincidentdetail = new /aws1/cl_smipagerdutyinciden01(
              iv_autoresolve = ABAP_TRUE
              iv_id = |string|
              iv_secretid = |string|
            )
            iv_arn = |string|
            iv_metricdefinition = |string|
            iv_url = |string|
          )
          iv_type = |string|
        )
        iv_generatedid = |string|
        iv_title = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_impact = 123
  iv_responseplanarn = |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_arn = lo_result->get_incidentrecordarn( ).
ENDIF.