Describe Engagement

ssmcontacts_describe_engagement

R Documentation

Incident Manager uses engagements to engage contacts and escalation plans during an incident¶

Description¶

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Usage¶

ssmcontacts_describe_engagement(EngagementId)

Arguments¶

EngagementId: [required] The Amazon Resource Name (ARN) of the engagement you want the details of.

Value¶

A list with the following syntax:

list(
  ContactArn = "string",
  EngagementArn = "string",
  Sender = "string",
  Subject = "string",
  Content = "string",
  PublicSubject = "string",
  PublicContent = "string",
  IncidentId = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  StopTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$describe_engagement(
  EngagementId = "string"
)

Examples¶

## Not run: 
# The following describe-engagement example lists the details of an
# engagement to a contact or escalation plan. The subject and content are
# sent to the contact channels.
svc$describe_engagement(
  EngagementId = "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/ex..."
)

## End(Not run)