Create Contact Channel
ssmcontacts_create_contact_channel | R 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.
Usage¶
ssmcontacts_create_contact_channel(ContactId, Name, Type,
DeliveryAddress, DeferActivation, IdempotencyToken)
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.
Value¶
A list with the following syntax:
Request syntax¶
svc$create_contact_channel(
ContactId = "string",
Name = "string",
Type = "SMS"|"VOICE"|"EMAIL",
DeliveryAddress = list(
SimpleAddress = "string"
),
DeferActivation = TRUE|FALSE,
IdempotencyToken = "string"
)
Examples¶
## Not run:
# Creates a contact channel of type SMS for the contact Akua Mansa.
# Contact channels can be created of type SMS, EMAIL, or VOICE.
svc$create_contact_channel(
ContactId = "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam",
DeliveryAddress = list(
SimpleAddress = "+15005550199"
),
Name = "akuas sms-test",
Type = "SMS"
)
## End(Not run)