ContactChannel
The method that Incident Manager uses to engage a contact.
Contents
- ActivationStatus
-
A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.
Type: String
Valid Values:
ACTIVATED | NOT_ACTIVATEDRequired: Yes
- ContactArn
-
The ARN of the contact that contains the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*Required: Yes
- ContactChannelArn
-
The Amazon Resource Name (ARN) of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*Required: Yes
- DeliveryAddress
-
The details that Incident Manager uses when trying to engage the contact channel.
Type: ContactChannelAddress object
Required: Yes
- Name
-
The name of the contact channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[\p{L}\p{Z}\p{N}_.\-]*$Required: Yes
- Type
-
The type of the contact channel. Incident Manager supports three contact methods:
-
SMS
-
VOICE
-
EMAIL
Type: String
Valid Values:
SMS | VOICE | EMAILRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
