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.CreateProjectVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 model in 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.

Synopsis

data CreateProjectVersion = CreateProjectVersion' {
- kmsKeyId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- testingData :: Maybe TestingData
- trainingData :: Maybe TrainingData
- projectArn :: Text
- versionName :: Text
- outputConfig :: OutputConfig
}
newCreateProjectVersion :: Text -> Text -> OutputConfig -> CreateProjectVersion
createProjectVersion_kmsKeyId :: Lens' CreateProjectVersion (Maybe Text)
createProjectVersion_tags :: Lens' CreateProjectVersion (Maybe (HashMap Text Text))
createProjectVersion_testingData :: Lens' CreateProjectVersion (Maybe TestingData)
createProjectVersion_trainingData :: Lens' CreateProjectVersion (Maybe TrainingData)
createProjectVersion_projectArn :: Lens' CreateProjectVersion Text
createProjectVersion_versionName :: Lens' CreateProjectVersion Text
createProjectVersion_outputConfig :: Lens' CreateProjectVersion OutputConfig
data CreateProjectVersionResponse = CreateProjectVersionResponse' {
- projectVersionArn :: Maybe Text
- httpStatus :: Int
}
newCreateProjectVersionResponse :: Int -> CreateProjectVersionResponse
createProjectVersionResponse_projectVersionArn :: Lens' CreateProjectVersionResponse (Maybe Text)
createProjectVersionResponse_httpStatus :: Lens' CreateProjectVersionResponse Int

Creating a Request

data CreateProjectVersion Source #

See: newCreateProjectVersion smart constructor.

Constructors

CreateProjectVersion'

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 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.
tags :: Maybe (HashMap Text Text)
A set of tags (key-value pairs) that you want to attach to the model.
testingData :: Maybe TestingData
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.
trainingData :: Maybe TrainingData
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.
projectArn :: Text
The ARN of the Amazon Rekognition Custom Labels project that manages the model that you want to train.
versionName :: Text
A name for the version of the model. This value must be unique.
outputConfig :: OutputConfig
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.

Instances

Instances details

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

newCreateProjectVersion Source #

Arguments

:: Text	`CreateProjectVersion`
-> Text	`$sel:versionName:CreateProjectVersion'`
-> OutputConfig	`CreateProjectVersion`
-> CreateProjectVersion

Create a value of CreateProjectVersion 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:

CreateProjectVersion, createProjectVersion_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 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.

$sel:tags:CreateProjectVersion', createProjectVersion_tags - A set of tags (key-value pairs) that you want to attach to the model.

$sel:testingData:CreateProjectVersion', createProjectVersion_testingData - 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.

$sel:trainingData:CreateProjectVersion', createProjectVersion_trainingData - 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.

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

$sel:versionName:CreateProjectVersion', createProjectVersion_versionName - A name for the version of the model. This value must be unique.

CreateProjectVersion, createProjectVersion_outputConfig - 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.

Request Lenses

createProjectVersion_kmsKeyId :: Lens' CreateProjectVersion (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 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.

createProjectVersion_tags :: Lens' CreateProjectVersion (Maybe (HashMap Text Text)) Source #

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

createProjectVersion_testingData :: Lens' CreateProjectVersion (Maybe TestingData) Source #

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.

createProjectVersion_trainingData :: Lens' CreateProjectVersion (Maybe TrainingData) Source #

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.

createProjectVersion_projectArn :: Lens' CreateProjectVersion Text Source #

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

createProjectVersion_versionName :: Lens' CreateProjectVersion Text Source #

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

createProjectVersion_outputConfig :: Lens' CreateProjectVersion OutputConfig Source #

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.

Destructuring the Response

data CreateProjectVersionResponse Source #

See: newCreateProjectVersionResponse smart constructor.

Constructors

CreateProjectVersionResponse'
Fields projectVersionArn :: Maybe Text The ARN of the model version that was created. Use `DescribeProjectVersion` to get the current status of the training operation. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateProjectVersionResponse Source #

Arguments

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

Create a value of CreateProjectVersionResponse 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:

CreateProjectVersionResponse, createProjectVersionResponse_projectVersionArn - The ARN of the model version that was created. Use DescribeProjectVersion to get the current status of the training operation.

$sel:httpStatus:CreateProjectVersionResponse', createProjectVersionResponse_httpStatus - The response's http status code.

Response Lenses

createProjectVersionResponse_projectVersionArn :: Lens' CreateProjectVersionResponse (Maybe Text) Source #

The ARN of the model version that was created. Use DescribeProjectVersion to get the current status of the training operation.

createProjectVersionResponse_httpStatus :: Lens' CreateProjectVersionResponse Int Source #

The response's http status code.