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.

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

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 BeginStartEntitiesDetectionJob and EndStartEntitiesDetectionJob.

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

Syntax

C#
public abstract Task<StartEntitiesDetectionJobResponse> StartEntitiesDetectionJobAsync(
         StartEntitiesDetectionJobRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Comprehend.Model.StartEntitiesDetectionJobRequest

Container for the necessary parameters to execute the StartEntitiesDetectionJob 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 StartEntitiesDetectionJob service method, as returned by Comprehend.

Exceptions

ExceptionCondition
InternalServerException An internal server error occurred. Retry your request.
InvalidRequestException The request is invalid.
KmsKeyValidationException The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.
ResourceInUseException The specified resource name is already in use. Use a different name and try your request again.
ResourceNotFoundException The specified resource ARN was not found. Check the ARN and try your request again.
ResourceUnavailableException The specified resource is not available. Check the resource and try your request again.
TooManyRequestsException The number of requests exceeds the limit. Resubmit your request later.
TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also