IAmazonSSMContacts.StopEngagement Method (StopEngagementRequest)

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StopEngagementAsync.

Namespace: Amazon.SSMContacts
Assembly: AWSSDK.SSMContacts.dll
Version: 3.x.y.z

Syntax

public abstract StopEngagementResponse StopEngagement(
         StopEngagementRequest request
)

Parameters

request: Type: Amazon.SSMContacts.Model.StopEngagementRequest

Container for the necessary parameters to execute the StopEngagement service method.

Return Value

Type: StopEngagementResponse

The response from the StopEngagement service method, as returned by SSMContacts.

Exceptions

Exception	Condition
AccessDeniedException	You don't have sufficient access to perform this operation.
InternalServerException	Unexpected error occurred while processing the request.
ResourceNotFoundException	Request references a resource that doesn't exist.
ThrottlingException	The request was denied due to request throttling.
ValidationException	The input fails to satisfy the constraints specified by an Amazon Web Services service.

Examples

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

To stop an engagement


var client = new AmazonSSMContactsClient();
var response = client.StopEngagement(new StopEngagementRequest 
{
    EngagementId = "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonSSMContacts.StopEngagement (StopEngagementRequest)

Method