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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts the running of the version of a model. Starting a model takes a while to complete. To check the current state of the model, use DescribeProjectVersions.

Once the model is running, you can detect custom labels in new images by calling DetectCustomLabels.

You are charged for the amount of time that the model is running. To stop a running model, call StopProjectVersion.

For more information, see /Running a trained Amazon Rekognition Custom Labels model/ in the Amazon Rekognition Custom Labels Guide.

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

Creating a Request

data StartProjectVersion Source #

See: newStartProjectVersion smart constructor.

Constructors

StartProjectVersion'

Fields

maxInferenceUnits :: Maybe Natural
The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.
projectVersionArn :: Text
The Amazon Resource Name(ARN) of the model version that you want to start.
minInferenceUnits :: Natural
The minimum number of inference units to use. A single inference unit represents 1 hour of processing.
For information about the number of transactions per second (TPS) that an inference unit can support, see /Running a trained Amazon Rekognition Custom Labels model/ in the Amazon Rekognition Custom Labels Guide.
Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Instances

Instances details

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

newStartProjectVersion Source #

Arguments

:: Text	`StartProjectVersion`
-> Natural	`StartProjectVersion`
-> StartProjectVersion

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

StartProjectVersion, startProjectVersion_maxInferenceUnits - The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.

StartProjectVersion, startProjectVersion_projectVersionArn - The Amazon Resource Name(ARN) of the model version that you want to start.

StartProjectVersion, startProjectVersion_minInferenceUnits - The minimum number of inference units to use. A single inference unit represents 1 hour of processing.

For information about the number of transactions per second (TPS) that an inference unit can support, see /Running a trained Amazon Rekognition Custom Labels model/ in the Amazon Rekognition Custom Labels Guide.

Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Request Lenses

startProjectVersion_maxInferenceUnits :: Lens' StartProjectVersion (Maybe Natural) Source #

The maximum number of inference units to use for auto-scaling the model. If you don't specify a value, Amazon Rekognition Custom Labels doesn't auto-scale the model.

startProjectVersion_projectVersionArn :: Lens' StartProjectVersion Text Source #

The Amazon Resource Name(ARN) of the model version that you want to start.

startProjectVersion_minInferenceUnits :: Lens' StartProjectVersion Natural Source #

The minimum number of inference units to use. A single inference unit represents 1 hour of processing.

For information about the number of transactions per second (TPS) that an inference unit can support, see /Running a trained Amazon Rekognition Custom Labels model/ in the Amazon Rekognition Custom Labels Guide.

Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use.

Destructuring the Response

data StartProjectVersionResponse Source #

See: newStartProjectVersionResponse smart constructor.

Constructors

StartProjectVersionResponse'
Fields status :: Maybe ProjectVersionStatus The current running status of the model. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartProjectVersionResponse Source #

Arguments

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

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

StartProjectVersionResponse, startProjectVersionResponse_status - The current running status of the model.

$sel:httpStatus:StartProjectVersionResponse', startProjectVersionResponse_httpStatus - The response's http status code.

Response Lenses

startProjectVersionResponse_status :: Lens' StartProjectVersionResponse (Maybe ProjectVersionStatus) Source #

The current running status of the model.

startProjectVersionResponse_httpStatus :: Lens' StartProjectVersionResponse Int Source #

The response's http status code.