Skip to content

Update Response Plan

ssmincidents_update_response_plan R Documentation

Updates the specified response plan

Description

Updates the specified response plan.

Usage

ssmincidents_update_response_plan(actions, arn, chatChannel,
  clientToken, displayName, engagements, incidentTemplateDedupeString,
  incidentTemplateImpact, incidentTemplateNotificationTargets,
  incidentTemplateSummary, incidentTemplateTags, incidentTemplateTitle,
  integrations)

Arguments

actions

The actions that this response plan takes at the beginning of an incident.

arn

[required] The Amazon Resource Name (ARN) of the response plan.

chatChannel

The Chatbot chat channel used for collaboration during an incident.

Use the empty structure to remove the chat channel from the response plan.

clientToken

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

displayName

The long format name of the response plan. The display name can't contain spaces.

engagements

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incidentTemplateDedupeString

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

incidentTemplateImpact

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

incidentTemplateNotificationTargets

The Amazon SNS targets that are notified when updates are made to an incident.

incidentTemplateSummary

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

incidentTemplateTags

Tags to assign to the template. When the start_incident API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the tag_resource API action for the incident record resource.

incidentTemplateTitle

The short format name of the incident. The title can't contain spaces.

integrations

Information about third-party services integrated into the response plan.

Value

An empty list.

Request syntax

svc$update_response_plan(
  actions = list(
    list(
      ssmAutomation = list(
        documentName = "string",
        documentVersion = "string",
        dynamicParameters = list(
          list(
            variable = "INCIDENT_RECORD_ARN"|"INVOLVED_RESOURCES"
          )
        ),
        parameters = list(
          list(
            "string"
          )
        ),
        roleArn = "string",
        targetAccount = "RESPONSE_PLAN_OWNER_ACCOUNT"|"IMPACTED_ACCOUNT"
      )
    )
  ),
  arn = "string",
  chatChannel = list(
    chatbotSns = list(
      "string"
    ),
    empty = list()
  ),
  clientToken = "string",
  displayName = "string",
  engagements = list(
    "string"
  ),
  incidentTemplateDedupeString = "string",
  incidentTemplateImpact = 123,
  incidentTemplateNotificationTargets = list(
    list(
      snsTopicArn = "string"
    )
  ),
  incidentTemplateSummary = "string",
  incidentTemplateTags = list(
    "string"
  ),
  incidentTemplateTitle = "string",
  integrations = list(
    list(
      pagerDutyConfiguration = list(
        name = "string",
        pagerDutyIncidentConfiguration = list(
          serviceId = "string"
        ),
        secretId = "string"
      )
    )
  )
)