Skip to content

Get Contact Channel

ssmcontacts_get_contact_channel R Documentation

List details about a specific contact channel

Description

List details about a specific contact channel.

Usage

ssmcontacts_get_contact_channel(ContactChannelId)

Arguments

ContactChannelId

[required] The Amazon Resource Name (ARN) of the contact channel you want information about.

Value

A list with the following syntax:

list(
  ContactArn = "string",
  ContactChannelArn = "string",
  Name = "string",
  Type = "SMS"|"VOICE"|"EMAIL",
  DeliveryAddress = list(
    SimpleAddress = "string"
  ),
  ActivationStatus = "ACTIVATED"|"NOT_ACTIVATED"
)

Request syntax

svc$get_contact_channel(
  ContactChannelId = "string"
)

Examples

## Not run: 
# The following get-contact-channel example lists the details of a contact
# channel.
svc$get_contact_channel(
  ContactChannelId = "arn:aws:ssm-contacts:us-east-2:111122223333:contact-c..."
)

## End(Not run)