SSMContacts / Client / delete_contact_channel

delete_contact_channel#

SSMContacts.Client.delete_contact_channel(**kwargs)#

To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact’s engagement plan. If you delete the only contact channel for a contact, you won’t be able to engage that contact during an incident.

See also: AWS API Documentation

Request Syntax

response = client.delete_contact_channel(
    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.InternalServerException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.ValidationException

Examples

The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident.

response = client.delete_contact_channel(
    ContactChannelId='arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2',
)

print(response)

Expected Output:

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