Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.LookoutVision.CreateModel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new version of a model within an an Amazon Lookout for Vision project. CreateModel is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model.

To get the current status, check the Status field returned in the response from DescribeModel.

If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.

After training completes, the evaluation metrics are stored at the location specified in OutputConfig.

This operation requires permissions to perform the lookoutvision:CreateModel operation. If you want to tag your model, you also require permission to the lookoutvision:TagResource operation.

Synopsis

data CreateModel = CreateModel' {
- clientToken :: Maybe Text
- kmsKeyId :: Maybe Text
- description :: Maybe Text
- tags :: Maybe [Tag]
- projectName :: Text
- outputConfig :: OutputConfig
}
newCreateModel :: Text -> OutputConfig -> CreateModel
createModel_clientToken :: Lens' CreateModel (Maybe Text)
createModel_kmsKeyId :: Lens' CreateModel (Maybe Text)
createModel_description :: Lens' CreateModel (Maybe Text)
createModel_tags :: Lens' CreateModel (Maybe [Tag])
createModel_projectName :: Lens' CreateModel Text
createModel_outputConfig :: Lens' CreateModel OutputConfig
data CreateModelResponse = CreateModelResponse' {
- modelMetadata :: Maybe ModelMetadata
- httpStatus :: Int
}
newCreateModelResponse :: Int -> CreateModelResponse
createModelResponse_modelMetadata :: Lens' CreateModelResponse (Maybe ModelMetadata)
createModelResponse_httpStatus :: Lens' CreateModelResponse Int

Creating a Request

data CreateModel Source #

See: newCreateModel smart constructor.

Constructors

CreateModel'

Fields

clientToken :: Maybe Text
ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel. An idempotency token is active for 8 hours.
kmsKeyId :: Maybe Text
The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.
description :: Maybe Text
A description for the version of the model.
tags :: Maybe [Tag]
A set of tags (key-value pairs) that you want to attach to the model.
projectName :: Text
The name of the project in which you want to create a model version.
outputConfig :: OutputConfig
The location where Amazon Lookout for Vision saves the training results.

Instances

Instances details

Eq CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods (==) :: CreateModel -> CreateModel -> Bool # (/=) :: CreateModel -> CreateModel -> Bool #
Read CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods readsPrec :: Int -> ReadS CreateModel # readList :: ReadS [CreateModel] # readPrec :: ReadPrec CreateModel # readListPrec :: ReadPrec [CreateModel] #
Show CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods showsPrec :: Int -> CreateModel -> ShowS # show :: CreateModel -> String # showList :: [CreateModel] -> ShowS #
Generic CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Associated Types type Rep CreateModel :: Type -> Type # Methods from :: CreateModel -> Rep CreateModel x # to :: Rep CreateModel x -> CreateModel #
NFData CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods rnf :: CreateModel -> () #
Hashable CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods hashWithSalt :: Int -> CreateModel -> Int # hash :: CreateModel -> Int #
ToJSON CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods toJSON :: CreateModel -> Value # toEncoding :: CreateModel -> Encoding # toJSONList :: [CreateModel] -> Value # toEncodingList :: [CreateModel] -> Encoding #
AWSRequest CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Associated Types type AWSResponse CreateModel # Methods request :: CreateModel -> Request CreateModel # response :: MonadResource m => Logger -> Service -> Proxy CreateModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateModel))) #
ToHeaders CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods toHeaders :: CreateModel -> [Header] #
ToPath CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods toPath :: CreateModel -> ByteString #
ToQuery CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods toQuery :: CreateModel -> QueryString #
type Rep CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel type Rep CreateModel = D1 ('MetaData "CreateModel" "Amazonka.LookoutVision.CreateModel" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "CreateModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "outputConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputConfig)))))
type AWSResponse CreateModel Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel type AWSResponse CreateModel = CreateModelResponse

newCreateModel Source #

Arguments

:: Text	`$sel:projectName:CreateModel'`
-> OutputConfig	`$sel:outputConfig:CreateModel'`
-> CreateModel

Create a value of CreateModel 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:clientToken:CreateModel', createModel_clientToken - ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel. An idempotency token is active for 8 hours.

$sel:kmsKeyId:CreateModel', createModel_kmsKeyId - The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

$sel:description:CreateModel', createModel_description - A description for the version of the model.

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

$sel:projectName:CreateModel', createModel_projectName - The name of the project in which you want to create a model version.

$sel:outputConfig:CreateModel', createModel_outputConfig - The location where Amazon Lookout for Vision saves the training results.

Request Lenses

createModel_clientToken :: Lens' CreateModel (Maybe Text) Source #

ClientToken is an idempotency token that ensures a call to CreateModel completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from CreateModel. In this case, safely retry your call to CreateModel by using the same ClientToken parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for ClientToken is considered a new call to CreateModel. An idempotency token is active for 8 hours.

createModel_kmsKeyId :: Lens' CreateModel (Maybe Text) Source #

The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.

createModel_description :: Lens' CreateModel (Maybe Text) Source #

A description for the version of the model.

createModel_tags :: Lens' CreateModel (Maybe [Tag]) Source #

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

createModel_projectName :: Lens' CreateModel Text Source #

The name of the project in which you want to create a model version.

createModel_outputConfig :: Lens' CreateModel OutputConfig Source #

The location where Amazon Lookout for Vision saves the training results.

Destructuring the Response

data CreateModelResponse Source #

See: newCreateModelResponse smart constructor.

Constructors

CreateModelResponse'
Fields modelMetadata :: Maybe ModelMetadata The response from a call to `CreateModel`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateModelResponse Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods (==) :: CreateModelResponse -> CreateModelResponse -> Bool # (/=) :: CreateModelResponse -> CreateModelResponse -> Bool #
Read CreateModelResponse Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods readsPrec :: Int -> ReadS CreateModelResponse # readList :: ReadS [CreateModelResponse] # readPrec :: ReadPrec CreateModelResponse # readListPrec :: ReadPrec [CreateModelResponse] #
Show CreateModelResponse Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods showsPrec :: Int -> CreateModelResponse -> ShowS # show :: CreateModelResponse -> String # showList :: [CreateModelResponse] -> ShowS #
Generic CreateModelResponse Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Associated Types type Rep CreateModelResponse :: Type -> Type # Methods from :: CreateModelResponse -> Rep CreateModelResponse x # to :: Rep CreateModelResponse x -> CreateModelResponse #
NFData CreateModelResponse Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel Methods rnf :: CreateModelResponse -> () #
type Rep CreateModelResponse Source #
Instance details Defined in Amazonka.LookoutVision.CreateModel type Rep CreateModelResponse = D1 ('MetaData "CreateModelResponse" "Amazonka.LookoutVision.CreateModel" "libZSservicesZSamazonka-lookoutvisionZSamazonka-lookoutvision" 'False) (C1 ('MetaCons "CreateModelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "modelMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelMetadata)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateModelResponse Source #

Arguments

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

Create a value of CreateModelResponse 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:modelMetadata:CreateModelResponse', createModelResponse_modelMetadata - The response from a call to CreateModel.

$sel:httpStatus:CreateModelResponse', createModelResponse_httpStatus - The response's http status code.

Response Lenses

createModelResponse_modelMetadata :: Lens' CreateModelResponse (Maybe ModelMetadata) Source #

The response from a call to CreateModel.

createModelResponse_httpStatus :: Lens' CreateModelResponse Int Source #

The response's http status code.