AmazonRekognitionClient.StopProjectVersion Method (StopProjectVersionRequest)

This operation applies only to Amazon Rekognition Custom Labels.

Stops a running model. The operation might take a while to complete. To check the current status, call DescribeProjectVersions. Only applies to Custom Labels projects.

This operation requires permissions to perform the rekognition:StopProjectVersion action.

Note:

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

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

Syntax

public virtual StopProjectVersionResponse StopProjectVersion(
         StopProjectVersionRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.StopProjectVersionRequest

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

Return Value

Type: StopProjectVersionResponse

The response from the StopProjectVersion service method, as returned by Rekognition.

Exceptions

Exception	Condition
AccessDeniedException	You are not authorized to perform the action.
InternalServerErrorException	Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException	Input parameter violated a constraint. Validate your parameter before calling the API operation again.
ProvisionedThroughputExceededException	The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceInUseException	The specified resource is already being used.
ResourceNotFoundException	The resource specified in the request cannot be found.
ThrottlingException	Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Stops a version of an Amazon Rekognition Custom Labels model.

To stop an Amazon Rekognition Custom Labels model.


var client = new AmazonRekognitionClient();
var response = client.StopProjectVersion(new StopProjectVersionRequest 
{
    ProjectVersionArn = "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
});

string status = response.Status;

Version Information

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

AmazonRekognitionClient.StopProjectVersion (StopProjectVersionRequest)

Method