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.Comprehend.StopTrainingDocumentClassifier

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

Creating a Request

data StopTrainingDocumentClassifier Source #

See: newStopTrainingDocumentClassifier smart constructor.

Constructors

StopTrainingDocumentClassifier'
Fields documentClassifierArn :: Text The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

Instances

Instances details

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

newStopTrainingDocumentClassifier Source #

Arguments

:: Text	`StopTrainingDocumentClassifier`
-> StopTrainingDocumentClassifier

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

StopTrainingDocumentClassifier, stopTrainingDocumentClassifier_documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

Request Lenses

stopTrainingDocumentClassifier_documentClassifierArn :: Lens' StopTrainingDocumentClassifier Text Source #

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

Destructuring the Response

data StopTrainingDocumentClassifierResponse Source #

See: newStopTrainingDocumentClassifierResponse smart constructor.

Constructors

StopTrainingDocumentClassifierResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStopTrainingDocumentClassifierResponse Source #

Arguments

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

Create a value of StopTrainingDocumentClassifierResponse 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:httpStatus:StopTrainingDocumentClassifierResponse', stopTrainingDocumentClassifierResponse_httpStatus - The response's http status code.

Response Lenses

stopTrainingDocumentClassifierResponse_httpStatus :: Lens' StopTrainingDocumentClassifierResponse Int Source #

The response's http status code.