SSMContacts / Client / delete_contact

delete_contact

SSMContacts.Client.delete_contact(**kwargs)

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.

See also: AWS API Documentation

Request Syntax

response = client.delete_contact(
    ContactId='string'
)

Parameters:

ContactId (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the contact that you’re deleting.

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.ConflictException

• SSMContacts.Client.exceptions.ValidationException

Examples

The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them.

response = client.delete_contact(
    ContactId='arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr',
)

print(response)

Expected Output:

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