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

Contents

Description

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

Creating a Request

data DescribeDocumentClassificationJob Source #

See: newDescribeDocumentClassificationJob smart constructor.

Constructors

DescribeDocumentClassificationJob'
Fields jobId :: Text The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Instances

Instances details

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

newDescribeDocumentClassificationJob Source #

Arguments

:: Text	`DescribeDocumentClassificationJob`
-> DescribeDocumentClassificationJob

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

DescribeDocumentClassificationJob, describeDocumentClassificationJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Request Lenses

describeDocumentClassificationJob_jobId :: Lens' DescribeDocumentClassificationJob Text Source #

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Destructuring the Response

data DescribeDocumentClassificationJobResponse Source #

See: newDescribeDocumentClassificationJobResponse smart constructor.

Constructors

DescribeDocumentClassificationJobResponse'
Fields documentClassificationJobProperties :: Maybe DocumentClassificationJobProperties An object that describes the properties associated with the document classification job. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeDocumentClassificationJobResponse Source #

Arguments

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

Create a value of DescribeDocumentClassificationJobResponse 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:documentClassificationJobProperties:DescribeDocumentClassificationJobResponse', describeDocumentClassificationJobResponse_documentClassificationJobProperties - An object that describes the properties associated with the document classification job.

$sel:httpStatus:DescribeDocumentClassificationJobResponse', describeDocumentClassificationJobResponse_httpStatus - The response's http status code.

Response Lenses

describeDocumentClassificationJobResponse_documentClassificationJobProperties :: Lens' DescribeDocumentClassificationJobResponse (Maybe DocumentClassificationJobProperties) Source #

An object that describes the properties associated with the document classification job.

describeDocumentClassificationJobResponse_httpStatus :: Lens' DescribeDocumentClassificationJobResponse Int Source #

The response's http status code.