Struct aws_sdk_rekognition::client::fluent_builders::CreateProjectVersion

pub struct CreateProjectVersion { /* private fields */ }

Fluent builder constructing a request to CreateProjectVersion.

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

Training uses the training and test datasets associated with the project. For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.

You can train a modelin a project that doesn't have associated datasets by specifying manifest files in the TrainingData and TestingData fields.

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates the datasets for you using the most recent manifest files. You can no longer train a model version for the project by specifying manifest files.

Instead of training with a project without associated datasets, we recommend that you use the manifest files to create training and test datasets for the project.

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. Training completed successfully if the value of the Status field is TRAINING_COMPLETED.

If training fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels developers guide.

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

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

Implementations

impl CreateProjectVersion

pub async fn send(
    self
) -> Result<CreateProjectVersionOutput, SdkError<CreateProjectVersionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn project_arn(self, input: impl Into<String>) -> Self

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

pub fn set_project_arn(self, input: Option<String>) -> Self

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

pub fn version_name(self, input: impl Into<String>) -> Self

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

pub fn set_version_name(self, input: Option<String>) -> Self

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

pub fn output_config(self, input: OutputConfig) -> Self

The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has s3:PutObject permissions on the S3 bucket.

pub fn set_output_config(self, input: Option<OutputConfig>) -> Self

The Amazon S3 bucket location to store the results of training. The S3 bucket can be in any AWS account as long as the caller has s3:PutObject permissions on the S3 bucket.

pub fn training_data(self, input: TrainingData) -> Self

Specifies an external manifest that the services uses to train the model. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

pub fn set_training_data(self, input: Option<TrainingData>) -> Self

Specifies an external manifest that the services uses to train the model. If you specify TrainingData you must also specify TestingData. The project must not have any associated datasets.

pub fn testing_data(self, input: TestingData) -> Self

Specifies an external manifest that the service uses to test the model. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

pub fn set_testing_data(self, input: Option<TestingData>) -> Self

Specifies an external manifest that the service uses to test the model. If you specify TestingData you must also specify TrainingData. The project must not have any associated datasets.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Tags.

To override the contents of this collection use set_tags.

A set of tags (key-value pairs) that you want to attach to the model.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

A set of tags (key-value pairs) that you want to attach to the model.

pub fn kms_key_id(self, input: impl Into<String>) -> Self

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

• kms:CreateGrant

• kms:DescribeKey

• kms:GenerateDataKey

• kms:Decrypt

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

pub fn set_kms_key_id(self, input: Option<String>) -> Self

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN. The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. The key is also used to encrypt training results and manifest files written to the output Amazon S3 bucket (OutputConfig).

If you choose to use your own KMS key, you need the following permissions on the KMS key.

• kms:CreateGrant

• kms:DescribeKey

• kms:GenerateDataKey

• kms:Decrypt

If you don't specify a value for KmsKeyId, images copied into the service are encrypted using a key that AWS owns and manages.

Trait Implementations

impl Clone for CreateProjectVersion

fn clone(&self) -> CreateProjectVersion

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateProjectVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.