SSMContacts / Client / stop_engagement

stop_engagement#

SSMContacts.Client.stop_engagement(**kwargs)#

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren’t engaged.

See also: AWS API Documentation

Request Syntax

response = client.stop_engagement(
    EngagementId='string',
    Reason='string'
)
Parameters:

  • EngagementId (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the engagement.

  • Reason (string) – The reason that you’re stopping the engagement.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • SSMContacts.Client.exceptions.AccessDeniedException

  • SSMContacts.Client.exceptions.ValidationException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.InternalServerException

Examples

The following stop-engagement example stops an engagement from paging further contacts and contact channels.

response = client.stop_engagement(
    EngagementId='arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356',
)

print(response)

Expected Output:

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