ssmcontacts_create_contact_channel: A contact channel is the method that Incident Manager uses to...

View source: R/ssmcontacts_operations.R

ssmcontacts_create_contact_channelR Documentation

A contact channel is the method that Incident Manager uses to engage your contact

Description

A contact channel is the method that Incident Manager uses to engage your contact.

See https://www.paws-r-sdk.com/docs/ssmcontacts_create_contact_channel/ for full documentation.

Usage

ssmcontacts_create_contact_channel(
  ContactId,
  Name,
  Type,
  DeliveryAddress,
  DeferActivation = NULL,
  IdempotencyToken = NULL
)

Arguments

ContactId

[required] The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

Name

[required] The name of the contact channel.

Type

[required] Incident Manager supports three types of contact channels:

  • SMS

  • VOICE

  • EMAIL

DeliveryAddress

[required] The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

  • SMS - '+' followed by the country code and phone number

  • VOICE - '+' followed by the country code and phone number

  • EMAIL - any standard email format

DeferActivation

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

IdempotencyToken

A token ensuring that the operation is called only once with the specified details.


paws.management documentation built on Sept. 12, 2024, 6:19 a.m.