com.amazonaws.services.rekognition.model

Class CreateProjectVersionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.CreateProjectVersionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateProjectVersionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a new version of a model and begins training. Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify one training dataset and one testing dataset. The response from CreateProjectVersion is an Amazon Resource Name (ARN) for the version of the model.

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

After evaluating the model, you start the model by calling StartProjectVersion.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateProjectVersionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
OutputConfig	getOutputConfig() The Amazon S3 location to store the results of training.
java.lang.String	getProjectArn() The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
TestingData	getTestingData() The dataset to use for testing.
TrainingData	getTrainingData() The dataset to use for training.
java.lang.String	getVersionName() A name for the version of the model.
int	hashCode()
void	setOutputConfig(OutputConfig outputConfig) The Amazon S3 location to store the results of training.
void	setProjectArn(java.lang.String projectArn) The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
void	setTestingData(TestingData testingData) The dataset to use for testing.
void	setTrainingData(TrainingData trainingData) The dataset to use for training.
void	setVersionName(java.lang.String versionName) A name for the version of the model.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateProjectVersionRequest	withOutputConfig(OutputConfig outputConfig) The Amazon S3 location to store the results of training.
CreateProjectVersionRequest	withProjectArn(java.lang.String projectArn) The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
CreateProjectVersionRequest	withTestingData(TestingData testingData) The dataset to use for testing.
CreateProjectVersionRequest	withTrainingData(TrainingData trainingData) The dataset to use for training.
CreateProjectVersionRequest	withVersionName(java.lang.String versionName) A name for the version of the model.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateProjectVersionRequest

public CreateProjectVersionRequest()

Method Detail

getProjectArn

public java.lang.String getProjectArn()

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Returns:

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

setProjectArn

public void setProjectArn(java.lang.String projectArn)

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Parameters:

projectArn -

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

withProjectArn

public CreateProjectVersionRequest withProjectArn(java.lang.String projectArn)

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048
Pattern: (^arn:[a-z\d-]+:rekognition:[a-z\d-]+:\d{12}:project\/[a-zA -Z0-9_.\-]{1,255}\/[0-9]+$)

Parameters:

projectArn -

The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.

Returns:

A reference to this updated object so that method calls can be chained together.

getVersionName

public java.lang.String getVersionName()

A name for the version of the model. This value must be unique.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Returns:

A name for the version of the model. This value must be unique.

setVersionName

public void setVersionName(java.lang.String versionName)

A name for the version of the model. This value must be unique.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

versionName -

A name for the version of the model. This value must be unique.

withVersionName

public CreateProjectVersionRequest withVersionName(java.lang.String versionName)

A name for the version of the model. This value must be unique.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

versionName -

A name for the version of the model. This value must be unique.

Returns:

A reference to this updated object so that method calls can be chained together.

getOutputConfig

public OutputConfig getOutputConfig()

The Amazon S3 location to store the results of training.

Returns:

The Amazon S3 location to store the results of training.

setOutputConfig

public void setOutputConfig(OutputConfig outputConfig)

The Amazon S3 location to store the results of training.

Parameters:

outputConfig -

The Amazon S3 location to store the results of training.

withOutputConfig

public CreateProjectVersionRequest withOutputConfig(OutputConfig outputConfig)

The Amazon S3 location to store the results of training.

Returns a reference to this object so that method calls can be chained together.

Parameters:

outputConfig -

The Amazon S3 location to store the results of training.

Returns:

A reference to this updated object so that method calls can be chained together.

getTrainingData

public TrainingData getTrainingData()

The dataset to use for training.

Returns:

The dataset to use for training.

setTrainingData

public void setTrainingData(TrainingData trainingData)

The dataset to use for training.

Parameters:

trainingData -

The dataset to use for training.

withTrainingData

public CreateProjectVersionRequest withTrainingData(TrainingData trainingData)

The dataset to use for training.

Returns a reference to this object so that method calls can be chained together.

Parameters:

trainingData -

The dataset to use for training.

Returns:

A reference to this updated object so that method calls can be chained together.

getTestingData

public TestingData getTestingData()

The dataset to use for testing.

Returns:

The dataset to use for testing.

setTestingData

public void setTestingData(TestingData testingData)

The dataset to use for testing.

Parameters:

testingData -

The dataset to use for testing.

withTestingData

public CreateProjectVersionRequest withTestingData(TestingData testingData)

The dataset to use for testing.

Returns a reference to this object so that method calls can be chained together.

Parameters:

testingData -

The dataset to use for testing.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object