CopyProjectVersionRequest Class | AWS SDK for .NET V3

Container for the parameters to the CopyProjectVersion operation.

This operation applies only to Amazon Rekognition Custom Labels.

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and destination projects can be in different AWS accounts but must be in the same AWS Region. You can't copy a model to another AWS service.

To copy a model version to a different AWS account, you need to create a resource-based policy known as a project policy. You attach the project policy to the source project by calling PutProjectPolicy. The project policy gives permission to copy the model version from a trusting AWS account to a trusted account.

For more information creating and attaching a project policy, see Attaching a project policy (SDK) in the Amazon Rekognition Custom Labels Developer Guide.

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

Copying project versions is supported only for Custom Labels models.

To copy a model, the destination project, source project, and source model version must already exist.

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the ProjectVersionDescription object. The copy operation has finished when the value of Status is COPYING_COMPLETED.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.CopyProjectVersionRequest

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

Syntax

public class CopyProjectVersionRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The CopyProjectVersionRequest type exposes the following members

Constructors

	Name	Description
	CopyProjectVersionRequest()

Properties

Name	Type	Description
DestinationProjectArn	System.String	Gets and sets the property DestinationProjectArn. The ARN of the project in the trusted AWS account that you want to copy the model version to.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. 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 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.
OutputConfig	Amazon.Rekognition.Model.OutputConfig	Gets and sets the property OutputConfig. The S3 bucket and folder location where the training output for the source model version is placed.
SourceProjectArn	System.String	Gets and sets the property SourceProjectArn. The ARN of the source project in the trusting AWS account.
SourceProjectVersionArn	System.String	Gets and sets the property SourceProjectVersionArn. The ARN of the model version in the source project that you want to copy to a destination project.
Tags	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property Tags. The key-value tags to assign to the model version.
VersionName	System.String	Gets and sets the property VersionName. A name for the version of the model that's copied to the destination project.

Examples

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.

CopyProjectVersion


var client = new AmazonRekognitionClient();
var response = client.CopyProjectVersion(new CopyProjectVersionRequest 
{
    DestinationProjectArn = "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765",
    KmsKeyId = "arn:1234abcd-12ab-34cd-56ef-1234567890ab",
    OutputConfig = new OutputConfig {
        S3Bucket = "bucket-name",
        S3KeyPrefix = "path_to_folder"
    },
    SourceProjectArn = "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456",
    SourceProjectVersionArn = "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456",
    Tags = new Dictionary<string, string> {
        { "key1", "val1" }
    },
    VersionName = "DestinationVersionName_cross_account"
});

string projectVersionArn = response.ProjectVersionArn;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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