Rekognition / Client / copy_project_version

copy_project_version#

Rekognition.Client.copy_project_version(**kwargs)#

Note

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.copy_project_version(
    SourceProjectArn='string',
    SourceProjectVersionArn='string',
    DestinationProjectArn='string',
    VersionName='string',
    OutputConfig={
        'S3Bucket': 'string',
        'S3KeyPrefix': 'string'
    },
    Tags={
        'string': 'string'
    },
    KmsKeyId='string'
)
Parameters:

  • SourceProjectArn (string) –

    [REQUIRED]

    The ARN of the source project in the trusting AWS account.

  • SourceProjectVersionArn (string) –

    [REQUIRED]

    The ARN of the model version in the source project that you want to copy to a destination project.

  • DestinationProjectArn (string) –

    [REQUIRED]

    The ARN of the project in the trusted AWS account that you want to copy the model version to.

  • VersionName (string) –

    [REQUIRED]

    A name for the version of the model that’s copied to the destination project.

  • OutputConfig (dict) –

    [REQUIRED]

    The S3 bucket and folder location where the training output for the source model version is placed.

    • S3Bucket (string) –

      The S3 bucket where training output is placed.

    • S3KeyPrefix (string) –

      The prefix applied to the training output files.

  • Tags (dict) –

    The key-value tags to assign to the model version.

    • (string) –

      • (string) –

  • KmsKeyId (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'ProjectVersionArn': 'string'
}

Response Structure

  • (dict) –

    • ProjectVersionArn (string) –

      The ARN of the copied model version in the destination project.

Exceptions

  • Rekognition.Client.exceptions.AccessDeniedException

  • Rekognition.Client.exceptions.InternalServerError

  • Rekognition.Client.exceptions.InvalidParameterException

  • Rekognition.Client.exceptions.LimitExceededException

  • Rekognition.Client.exceptions.ResourceNotFoundException

  • Rekognition.Client.exceptions.ThrottlingException

  • Rekognition.Client.exceptions.ServiceQuotaExceededException

  • Rekognition.Client.exceptions.ProvisionedThroughputExceededException

  • Rekognition.Client.exceptions.ResourceInUseException