Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Rekognition.CopyProjectVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

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.

Synopsis

data CopyProjectVersion = CopyProjectVersion' {
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- sourceProjectArn :: Text
- sourceProjectVersionArn :: Text
- destinationProjectArn :: Text
- versionName :: Text
- outputConfig :: OutputConfig
}
newCopyProjectVersion :: Text -> Text -> Text -> Text -> OutputConfig -> CopyProjectVersion
copyProjectVersion_kmsKeyId :: Lens' CopyProjectVersion (Maybe Text)
copyProjectVersion_tags :: Lens' CopyProjectVersion (Maybe (HashMap Text Text))
copyProjectVersion_sourceProjectArn :: Lens' CopyProjectVersion Text
copyProjectVersion_sourceProjectVersionArn :: Lens' CopyProjectVersion Text
copyProjectVersion_destinationProjectArn :: Lens' CopyProjectVersion Text
copyProjectVersion_versionName :: Lens' CopyProjectVersion Text
copyProjectVersion_outputConfig :: Lens' CopyProjectVersion OutputConfig
data CopyProjectVersionResponse = CopyProjectVersionResponse' {
- projectVersionArn :: Maybe Text
- httpStatus :: Int
}
newCopyProjectVersionResponse :: Int -> CopyProjectVersionResponse
copyProjectVersionResponse_projectVersionArn :: Lens' CopyProjectVersionResponse (Maybe Text)
copyProjectVersionResponse_httpStatus :: Lens' CopyProjectVersionResponse Int

Creating a Request

data CopyProjectVersion Source #

See: newCopyProjectVersion smart constructor.

Constructors

CopyProjectVersion'

Fields

kmsKeyId :: Maybe Text
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.
tags :: Maybe (HashMap Text Text)
The key-value tags to assign to the model version.
sourceProjectArn :: Text
The ARN of the source project in the trusting AWS account.
sourceProjectVersionArn :: Text
The ARN of the model version in the source project that you want to copy to a destination project.
destinationProjectArn :: Text
The ARN of the project in the trusted AWS account that you want to copy the model version to.
versionName :: Text
A name for the version of the model that's copied to the destination project.
outputConfig :: OutputConfig
The S3 bucket and folder location where the training output for the source model version is placed.

Instances

Instances details

ToJSON CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods toJSON :: CopyProjectVersion -> Value # toEncoding :: CopyProjectVersion -> Encoding # toJSONList :: [CopyProjectVersion] -> Value # toEncodingList :: [CopyProjectVersion] -> Encoding #
ToHeaders CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods toHeaders :: CopyProjectVersion -> [Header] #
ToPath CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods toPath :: CopyProjectVersion -> ByteString #
ToQuery CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods toQuery :: CopyProjectVersion -> QueryString #
AWSRequest CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Associated Types type AWSResponse CopyProjectVersion # Methods request :: (Service -> Service) -> CopyProjectVersion -> Request CopyProjectVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CopyProjectVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CopyProjectVersion))) #
Generic CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Associated Types type Rep CopyProjectVersion :: Type -> Type # Methods from :: CopyProjectVersion -> Rep CopyProjectVersion x # to :: Rep CopyProjectVersion x -> CopyProjectVersion #
Read CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods readsPrec :: Int -> ReadS CopyProjectVersion # readList :: ReadS [CopyProjectVersion] # readPrec :: ReadPrec CopyProjectVersion # readListPrec :: ReadPrec [CopyProjectVersion] #
Show CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods showsPrec :: Int -> CopyProjectVersion -> ShowS # show :: CopyProjectVersion -> String # showList :: [CopyProjectVersion] -> ShowS #
NFData CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods rnf :: CopyProjectVersion -> () #
Eq CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods (==) :: CopyProjectVersion -> CopyProjectVersion -> Bool # (/=) :: CopyProjectVersion -> CopyProjectVersion -> Bool #
Hashable CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods hashWithSalt :: Int -> CopyProjectVersion -> Int # hash :: CopyProjectVersion -> Int #
type AWSResponse CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion type AWSResponse CopyProjectVersion = CopyProjectVersionResponse
type Rep CopyProjectVersion Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion type Rep CopyProjectVersion = D1 ('MetaData "CopyProjectVersion" "Amazonka.Rekognition.CopyProjectVersion" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "CopyProjectVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "sourceProjectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "sourceProjectVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "destinationProjectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputConfig)))))

newCopyProjectVersion Source #

Arguments

:: Text	`$sel:sourceProjectArn:CopyProjectVersion'`
-> Text	`CopyProjectVersion`
-> Text	`$sel:destinationProjectArn:CopyProjectVersion'`
-> Text	`$sel:versionName:CopyProjectVersion'`
-> OutputConfig	`CopyProjectVersion`
-> CopyProjectVersion

Create a value of CopyProjectVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CopyProjectVersion, copyProjectVersion_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.

$sel:tags:CopyProjectVersion', copyProjectVersion_tags - The key-value tags to assign to the model version.

$sel:sourceProjectArn:CopyProjectVersion', copyProjectVersion_sourceProjectArn - The ARN of the source project in the trusting AWS account.

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

$sel:destinationProjectArn:CopyProjectVersion', copyProjectVersion_destinationProjectArn - The ARN of the project in the trusted AWS account that you want to copy the model version to.

$sel:versionName:CopyProjectVersion', copyProjectVersion_versionName - A name for the version of the model that's copied to the destination project.

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

Request Lenses

copyProjectVersion_kmsKeyId :: Lens' CopyProjectVersion (Maybe Text) Source #

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.

copyProjectVersion_tags :: Lens' CopyProjectVersion (Maybe (HashMap Text Text)) Source #

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

copyProjectVersion_sourceProjectArn :: Lens' CopyProjectVersion Text Source #

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

copyProjectVersion_sourceProjectVersionArn :: Lens' CopyProjectVersion Text Source #

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

copyProjectVersion_destinationProjectArn :: Lens' CopyProjectVersion Text Source #

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

copyProjectVersion_versionName :: Lens' CopyProjectVersion Text Source #

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

copyProjectVersion_outputConfig :: Lens' CopyProjectVersion OutputConfig Source #

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

Destructuring the Response

data CopyProjectVersionResponse Source #

See: newCopyProjectVersionResponse smart constructor.

Constructors

CopyProjectVersionResponse'
Fields projectVersionArn :: Maybe Text The ARN of the copied model version in the destination project. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CopyProjectVersionResponse Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Associated Types type Rep CopyProjectVersionResponse :: Type -> Type # Methods from :: CopyProjectVersionResponse -> Rep CopyProjectVersionResponse x # to :: Rep CopyProjectVersionResponse x -> CopyProjectVersionResponse #
Read CopyProjectVersionResponse Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods readsPrec :: Int -> ReadS CopyProjectVersionResponse # readList :: ReadS [CopyProjectVersionResponse] # readPrec :: ReadPrec CopyProjectVersionResponse # readListPrec :: ReadPrec [CopyProjectVersionResponse] #
Show CopyProjectVersionResponse Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods showsPrec :: Int -> CopyProjectVersionResponse -> ShowS # show :: CopyProjectVersionResponse -> String # showList :: [CopyProjectVersionResponse] -> ShowS #
NFData CopyProjectVersionResponse Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods rnf :: CopyProjectVersionResponse -> () #
Eq CopyProjectVersionResponse Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion Methods (==) :: CopyProjectVersionResponse -> CopyProjectVersionResponse -> Bool # (/=) :: CopyProjectVersionResponse -> CopyProjectVersionResponse -> Bool #
type Rep CopyProjectVersionResponse Source #
Instance details Defined in Amazonka.Rekognition.CopyProjectVersion type Rep CopyProjectVersionResponse = D1 ('MetaData "CopyProjectVersionResponse" "Amazonka.Rekognition.CopyProjectVersion" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "CopyProjectVersionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCopyProjectVersionResponse Source #

Arguments

:: Int	`$sel:httpStatus:CopyProjectVersionResponse'`
-> CopyProjectVersionResponse

Create a value of CopyProjectVersionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CopyProjectVersionResponse, copyProjectVersionResponse_projectVersionArn - The ARN of the copied model version in the destination project.

$sel:httpStatus:CopyProjectVersionResponse', copyProjectVersionResponse_httpStatus - The response's http status code.

Response Lenses

copyProjectVersionResponse_projectVersionArn :: Lens' CopyProjectVersionResponse (Maybe Text) Source #

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

copyProjectVersionResponse_httpStatus :: Lens' CopyProjectVersionResponse Int Source #

The response's http status code.