Skip to content

List Pages By Engagement

ssmcontacts_list_pages_by_engagement R Documentation

Lists the engagements to contact channels that occurred by engaging a contact

Description

Lists the engagements to contact channels that occurred by engaging a contact.

Usage

ssmcontacts_list_pages_by_engagement(EngagementId, NextToken,
  MaxResults)

Arguments

EngagementId

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

The pagination token to continue to the next page of results.
MaxResults

The maximum number of engagements to contact channels to list per page of results.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Pages = list(
    list(
      PageArn = "string",
      EngagementArn = "string",
      ContactArn = "string",
      Sender = "string",
      IncidentId = "string",
      SentTime = as.POSIXct(
        "2015-01-01"
      ),
      DeliveryTime = as.POSIXct(
        "2015-01-01"
      ),
      ReadTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$list_pages_by_engagement(
  EngagementId = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# The following list-pages-by-engagement example lists the pages that
# occurred while engaging the defined engagement plan.
svc$list_pages_by_engagement(
  EngagementId = "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/ak..."
)

## End(Not run)