Skip to content

Get Contact

ssmcontacts_get_contact R Documentation

Retrieves information about the specified contact or escalation plan

Description

Retrieves information about the specified contact or escalation plan.

Usage

ssmcontacts_get_contact(ContactId)

Arguments

ContactId

[required] The Amazon Resource Name (ARN) of the contact or escalation plan.

Value

A list with the following syntax:

list(
  ContactArn = "string",
  Alias = "string",
  DisplayName = "string",
  Type = "PERSONAL"|"ESCALATION"|"ONCALL_SCHEDULE",
  Plan = list(
    Stages = list(
      list(
        DurationInMinutes = 123,
        Targets = list(
          list(
            ChannelTargetInfo = list(
              ContactChannelId = "string",
              RetryIntervalInMinutes = 123
            ),
            ContactTargetInfo = list(
              ContactId = "string",
              IsEssential = TRUE|FALSE
            )
          )
        )
      )
    ),
    RotationIds = list(
      "string"
    )
  )
)

Request syntax

svc$get_contact(
  ContactId = "string"
)