List Engagements

ssmcontacts_list_engagements

R Documentation

Lists all engagements that have happened in an incident¶

Description¶

Lists all engagements that have happened in an incident.

Usage¶

ssmcontacts_list_engagements(NextToken, MaxResults, IncidentId,
  TimeRangeValue)

Arguments¶

NextToken: The pagination token to continue to the next page of results.
MaxResults: The maximum number of engagements per page of results.
IncidentId: The Amazon Resource Name (ARN) of the incident you're listing engagements for.
TimeRangeValue: The time range to lists engagements for an incident.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  Engagements = list(
    list(
      EngagementArn = "string",
      ContactArn = "string",
      Sender = "string",
      IncidentId = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      StopTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$list_engagements(
  NextToken = "string",
  MaxResults = 123,
  IncidentId = "string",
  TimeRangeValue = list(
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  )
)