List Contacts

ssmcontacts_list_contacts

R Documentation

Lists all contacts and escalation plans in Incident Manager¶

Description¶

Lists all contacts and escalation plans in Incident Manager.

Usage¶

ssmcontacts_list_contacts(NextToken, MaxResults, AliasPrefix, Type)

Arguments¶

NextToken: The pagination token to continue to the next page of results.
MaxResults: The maximum number of contacts and escalation plans per page of results.
AliasPrefix: Used to list only contacts who's aliases start with the specified prefix.
Type: The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  Contacts = list(
    list(
      ContactArn = "string",
      Alias = "string",
      DisplayName = "string",
      Type = "PERSONAL"|"ESCALATION"|"ONCALL_SCHEDULE"
    )
  )
)

Request syntax¶

svc$list_contacts(
  NextToken = "string",
  MaxResults = 123,
  AliasPrefix = "string",
  Type = "PERSONAL"|"ESCALATION"|"ONCALL_SCHEDULE"
)