AmazonRekognitionClient.StartProjectVersion Method (StartProjectVersionRequest)

This operation applies only to Amazon Rekognition Custom Labels.

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

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

Note:

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

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

Syntax

public virtual StartProjectVersionResponse StartProjectVersion(
         StartProjectVersionRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.StartProjectVersionRequest

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

Return Value

Type: StartProjectVersionResponse

The response from the StartProjectVersion 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.
LimitExceededException	An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs concurrently, subsequent calls to start operations (ex: StartLabelDetection) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.
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

Starts a version of an Amazon Rekognition Custom Labels model.

To start an Amazon Rekognition Custom Labels model


var client = new AmazonRekognitionClient();
var response = client.StartProjectVersion(new StartProjectVersionRequest 
{
    MaxInferenceUnits = 1,
    MinInferenceUnits = 1,
    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.StartProjectVersion (StartProjectVersionRequest)

Method