Accept Page

ssmcontacts_accept_page

R Documentation

Used to acknowledge an engagement to a contact channel during an incident¶

Description¶

Used to acknowledge an engagement to a contact channel during an incident.

Usage¶

ssmcontacts_accept_page(PageId, ContactChannelId, AcceptType, Note,
  AcceptCode, AcceptCodeValidation)

Arguments¶

PageId

[required] The Amazon Resource Name (ARN) of the engagement to a contact channel.

ContactChannelId

The ARN of the contact channel.

AcceptType

[required] The type indicates if the page was DELIVERED or READ.

Note

Information provided by the user when the user acknowledges the page.

AcceptCode

[required] A 6-digit code used to acknowledge the page.

AcceptCodeValidation

An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

Value¶

An empty list.

Request syntax¶

svc$accept_page(
  PageId = "string",
  ContactChannelId = "string",
  AcceptType = "DELIVERED"|"READ",
  Note = "string",
  AcceptCode = "string",
  AcceptCodeValidation = "IGNORE"|"ENFORCE"
)

Examples¶

## Not run: 
# The following accept-page operation uses an accept code sent to the
# contact channel to accept a page.
svc$accept_page(
  AcceptCode = "425440",
  AcceptType = "READ",
  PageId = "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b..."
)

## End(Not run)