create_contact_channel
¶
create_contact_channel(
contact_id: SsmContactsArn,
name: ChannelName,
type: ChannelType,
delivery_address: ContactChannelAddress,
*,
config_overrides: Optional[SSMContactsClientConfig] = None,
defer_activation: Optional[DeferActivation] = None,
idempotency_token: Optional[IdempotencyToken] = None,
) -> CreateContactChannelResult
A contact channel is the method that Incident Manager uses to engage your contact.
Parameters:
-
contact_id(SsmContactsArn) –The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
-
name(ChannelName) –The name of the contact channel.
-
type(ChannelType) –Incident Manager supports three types of contact channels:
-
SMS -
VOICE -
EMAIL
-
-
delivery_address(ContactChannelAddress) –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
-
-
defer_activation(Optional[DeferActivation], default:None) –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.
-
idempotency_token(Optional[IdempotencyToken], default:None) –A token ensuring that the operation is called only once with the specified details.
Raises:
-
AccessDeniedException–You don't have sufficient access to perform this operation.
-
ConflictException–Updating or deleting a resource causes an inconsistent state.
-
DataEncryptionException–The operation failed to due an encryption key error.
-
InternalServerException–Unexpected error occurred while processing the request.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.