libZSservicesZSamazonka-rekognitionZSamazonka-rekognition
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Rekognition.CreateProjectVersion

Description

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

Training takes a while to complete. You can get the current status by calling DescribeProjectVersions.

Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the model.

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

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

Synopsis

Creating a Request

data CreateProjectVersion Source #

See: newCreateProjectVersion smart constructor.

Constructors

CreateProjectVersion' 

Fields

  • kmsKeyId :: Maybe Text

    The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK, an alias for your CMK, 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 CMK, you need the following permissions on the CMK.

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

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

  • trainingData :: TrainingData

    The dataset to use for training.

  • testingData :: TestingData

    The dataset to use for testing.

Instances

Instances details
Eq CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Methods

(==) :: CreateProjectVersion -> CreateProjectVersion -> Bool #

(/=) :: CreateProjectVersion -> CreateProjectVersion -> Bool #

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 #

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 #

NFData CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Methods

rnf :: CreateProjectVersion -> () #

Hashable CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Methods

hashWithSalt :: Int -> CreateProjectVersion -> Int #

hash :: CreateProjectVersion -> Int #

ToJSON CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Methods

toJSON :: CreateProjectVersion -> Value #

toEncoding :: CreateProjectVersion -> Encoding #

toJSONList :: [CreateProjectVersion] -> Value #

toEncodingList :: [CreateProjectVersion] -> Encoding #

AWSRequest CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Associated Types

type AWSResponse CreateProjectVersion #

Methods

request :: CreateProjectVersion -> Request CreateProjectVersion #

response :: MonadResource m => Logger -> Service -> Proxy CreateProjectVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProjectVersion))) #

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 #

type Rep CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

type Rep CreateProjectVersion = D1 ('MetaData "CreateProjectVersion" "Amazonka.Rekognition.CreateProjectVersion" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" '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 "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "versionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputConfig)) :*: (S1 ('MetaSel ('Just "trainingData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrainingData) :*: S1 ('MetaSel ('Just "testingData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TestingData)))))
type AWSResponse CreateProjectVersion Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

type AWSResponse CreateProjectVersion = CreateProjectVersionResponse

newCreateProjectVersion Source #

Arguments

:: Text

$sel:projectArn:CreateProjectVersion'

-> Text

$sel:versionName:CreateProjectVersion'

-> OutputConfig

$sel:outputConfig:CreateProjectVersion'

-> TrainingData

$sel:trainingData:CreateProjectVersion'

-> TestingData

$sel:testingData: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:

$sel:kmsKeyId:CreateProjectVersion', createProjectVersion_kmsKeyId - The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK, an alias for your CMK, 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 CMK, you need the following permissions on the CMK.

  • 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:projectArn: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.

$sel:outputConfig: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.

$sel:trainingData:CreateProjectVersion', createProjectVersion_trainingData - The dataset to use for training.

$sel:testingData:CreateProjectVersion', createProjectVersion_testingData - The dataset to use for testing.

Request Lenses

createProjectVersion_kmsKeyId :: Lens' CreateProjectVersion (Maybe Text) Source #

The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK, an alias for your CMK, 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 CMK, you need the following permissions on the CMK.

  • 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_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.

createProjectVersion_trainingData :: Lens' CreateProjectVersion TrainingData Source #

The dataset to use for training.

createProjectVersion_testingData :: Lens' CreateProjectVersion TestingData Source #

The dataset to use for testing.

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
Eq CreateProjectVersionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Methods

(==) :: CreateProjectVersionResponse -> CreateProjectVersionResponse -> Bool #

(/=) :: CreateProjectVersionResponse -> CreateProjectVersionResponse -> Bool #

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 #

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 #

NFData CreateProjectVersionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

Methods

rnf :: CreateProjectVersionResponse -> () #

type Rep CreateProjectVersionResponse Source # 
Instance details

Defined in Amazonka.Rekognition.CreateProjectVersion

type Rep CreateProjectVersionResponse = D1 ('MetaData "CreateProjectVersionResponse" "Amazonka.Rekognition.CreateProjectVersion" "libZSservicesZSamazonka-rekognitionZSamazonka-rekognition" '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:

$sel:projectVersionArn: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.