send_activation_code

SSMContacts.Client.send_activation_code(**kwargs)

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.

See also: AWS API Documentation

Request Syntax

response = client.send_activation_code(
    ContactChannelId='string'
)

Parameters

ContactChannelId (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the contact channel.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• SSMContacts.Client.exceptions.AccessDeniedException
• SSMContacts.Client.exceptions.DataEncryptionException
• SSMContacts.Client.exceptions.InternalServerException
• SSMContacts.Client.exceptions.ResourceNotFoundException
• SSMContacts.Client.exceptions.ServiceQuotaExceededException
• SSMContacts.Client.exceptions.ThrottlingException
• SSMContacts.Client.exceptions.ValidationException

Examples

The following send-activation-code example sends an activation code and message to the specified contact channel.

response = client.send_activation_code(
    ContactChannelId='arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}