SSMContacts / Client / deactivate_contact_channel

deactivate_contact_channel#

SSMContacts.Client.deactivate_contact_channel(**kwargs)#

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

Request Syntax

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

Parameters:

ContactChannelId (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the contact channel you’re deactivating.

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 deactivate-contact-channel example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation.

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

print(response)

Expected Output:

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