Container for the parameters to the StopEngagement operation. Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SSMContacts.AmazonSSMContactsRequest
Amazon.SSMContacts.Model.StopEngagementRequest
Namespace: Amazon.SSMContacts.Model
Assembly: AWSSDK.SSMContacts.dll
Version: 3.x.y.z
Syntax
public class StopEngagementRequest : AmazonSSMContactsRequest IAmazonWebServiceRequest
The StopEngagementRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StopEngagementRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
EngagementId | System.String |
Gets and sets the property EngagementId. The Amazon Resource Name (ARN) of the engagement. |
|
|
Reason | System.String |
Gets and sets the property Reason. The reason that you're stopping the engagement. |
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:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5