Start Engagement

ssmcontacts_start_engagement

R Documentation

Starts an engagement to a contact or escalation plan

Description

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Usage

ssmcontacts_start_engagement(ContactId, Sender, Subject, Content,
  PublicSubject, PublicContent, IncidentId, IdempotencyToken)

Arguments

ContactId

[required] The Amazon Resource Name (ARN) of the contact being engaged.

Sender

[required] The user that started the engagement.

Subject

[required] The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

Content

[required] The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

PublicSubject

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

PublicContent

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

IncidentId

The ARN of the incident that the engagement is part of.

IdempotencyToken

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

Value

A list with the following syntax:

list(
  EngagementArn = "string"
)

Request syntax

svc$start_engagement(
  ContactId = "string",
  Sender = "string",
  Subject = "string",
  Content = "string",
  PublicSubject = "string",
  PublicContent = "string",
  IncidentId = "string",
  IdempotencyToken = "string"
)

Examples

## Not run: 
# The following start-engagement pages contact's contact channels. Sender,
# subject, public-subject, and public-content are all free from fields.
# Incident Manager sends the subject and content to the provided VOICE or
# EMAIL contact channels. Incident Manager sends the public-subject and
# public-content to the provided SMS contact channels. Sender is used to
# track who started the engagement.
svc$start_engagement(
  ContactId = "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
  Content = "Testing engagements",
  PublicContent = "Testing engagements",
  PublicSubject = "test",
  Sender = "tester",
  Subject = "test"
)

# The following start-engagement engages contact's through an escalation
# plan. Each contact is paged according to their engagement plan.
svc$start_engagement(
  ContactId = "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation",
  Content = "Testing engagements",
  PublicContent = "Testing engagements",
  PublicSubject = "test",
  Sender = "tester",
  Subject = "test"
)

## End(Not run)