Rekognition / Client / stop_project_version

stop_project_version¶

Rekognition.Client.stop_project_version(**kwargs)¶

Note

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.

Request Syntax

response = client.stop_project_version(
    ProjectVersionArn='string'
)

Parameters:

ProjectVersionArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the model version that you want to stop.

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

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'TRAINING_IN_PROGRESS'|'TRAINING_COMPLETED'|'TRAINING_FAILED'|'STARTING'|'RUNNING'|'FAILED'|'STOPPING'|'STOPPED'|'DELETING'|'COPYING_IN_PROGRESS'|'COPYING_COMPLETED'|'COPYING_FAILED'|'DEPRECATED'|'EXPIRED'
}

Response Structure

(dict) –
- Status (string) –
  
  The current status of the stop operation.

Exceptions

Rekognition.Client.exceptions.ResourceNotFoundException
Rekognition.Client.exceptions.ResourceInUseException
Rekognition.Client.exceptions.InvalidParameterException
Rekognition.Client.exceptions.AccessDeniedException
Rekognition.Client.exceptions.InternalServerError
Rekognition.Client.exceptions.ThrottlingException
Rekognition.Client.exceptions.ProvisionedThroughputExceededException