Skip to content

Start Incident

ssmincidents_start_incident R Documentation

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

Description

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

Usage

ssmincidents_start_incident(clientToken, impact, relatedItems,
  responsePlanArn, title, triggerDetails)

Arguments

clientToken

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

impact

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

relatedItems

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.

responsePlanArn

[required] 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.

title

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

triggerDetails

Details of what created the incident record in Incident Manager.

Value

A list with the following syntax: 

list(
  incidentRecordArn = "string"
)

Request syntax

svc$start_incident(
  clientToken = "string",
  impact = 123,
  relatedItems = list(
    list(
      generatedId = "string",
      identifier = list(
        type = "ANALYSIS"|"INCIDENT"|"METRIC"|"PARENT"|"ATTACHMENT"|"OTHER"|"AUTOMATION"|"INVOLVED_RESOURCE"|"TASK",
        value = list(
          arn = "string",
          metricDefinition = "string",
          pagerDutyIncidentDetail = list(
            autoResolve = TRUE|FALSE,
            id = "string",
            secretId = "string"
          ),
          url = "string"
        )
      ),
      title = "string"
    )
  ),
  responsePlanArn = "string",
  title = "string",
  triggerDetails = list(
    rawData = "string",
    source = "string",
    timestamp = as.POSIXct(
      "2015-01-01"
    ),
    triggerArn = "string"
  )
)