Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

activate_contact_channel

activate_contact_channel(**kwargs)

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

See also: AWS API Documentation

Request Syntax

response = client.activate_contact_channel(
    ContactChannelId='string',
    ActivationCode='string'
)
Parameters
  • ContactChannelId (string) --

    [REQUIRED]

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

  • ActivationCode (string) --

    [REQUIRED]

    The code sent to the contact channel when it was created in the contact.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

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

Examples

The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident.

response = client.activate_contact_channel(
    ActivationCode='466136',
    ContactChannelId='arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d',
)

print(response)

Expected Output:

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