AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS, the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStopSentimentDetectionJob and EndStopSentimentDetectionJob.

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

Syntax

C#
public abstract Task<StopSentimentDetectionJobResponse> StopSentimentDetectionJobAsync(
         StopSentimentDetectionJobRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Comprehend.Model.StopSentimentDetectionJobRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StopSentimentDetectionJob service method, as returned by Comprehend.

Exceptions

ExceptionCondition
InternalServerException An internal server error occurred. Retry your request.
InvalidRequestException The request is invalid.
JobNotFoundException The specified job was not found. Check the job ID and try again.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also