Skip to content

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan

Description

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

Usage

ssmcontacts_stop_engagement(EngagementId, Reason)

Arguments

  • EngagementId

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

  • Reason

    The reason that you're stopping the engagement.

Value

An empty list.

Request syntax

svc$stop_engagement(
  EngagementId = "string",
  Reason = "string"
)

Examples

# The following stop-engagement example stops an engagement from paging
# further contacts and contact channels.
svc$stop_engagement(
  EngagementId = "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/ex..."
)