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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Creating a Request

data DescribeEntitiesDetectionJob Source #

See: newDescribeEntitiesDetectionJob smart constructor.

Constructors

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

Instances

Instances details

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

newDescribeEntitiesDetectionJob Source #

Arguments

:: Text	`$sel:jobId:DescribeEntitiesDetectionJob'`
-> DescribeEntitiesDetectionJob

Create a value of DescribeEntitiesDetectionJob 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:jobId:DescribeEntitiesDetectionJob', describeEntitiesDetectionJob_jobId - The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

Request Lenses

describeEntitiesDetectionJob_jobId :: Lens' DescribeEntitiesDetectionJob Text Source #

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

Destructuring the Response

data DescribeEntitiesDetectionJobResponse Source #

See: newDescribeEntitiesDetectionJobResponse smart constructor.

Constructors

DescribeEntitiesDetectionJobResponse'
Fields entitiesDetectionJobProperties :: Maybe EntitiesDetectionJobProperties An object that contains the properties associated with an entities detection job. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeEntitiesDetectionJobResponse Source #

Arguments

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

Create a value of DescribeEntitiesDetectionJobResponse 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:entitiesDetectionJobProperties:DescribeEntitiesDetectionJobResponse', describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties - An object that contains the properties associated with an entities detection job.

$sel:httpStatus:DescribeEntitiesDetectionJobResponse', describeEntitiesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

describeEntitiesDetectionJobResponse_entitiesDetectionJobProperties :: Lens' DescribeEntitiesDetectionJobResponse (Maybe EntitiesDetectionJobProperties) Source #

An object that contains the properties associated with an entities detection job.

describeEntitiesDetectionJobResponse_httpStatus :: Lens' DescribeEntitiesDetectionJobResponse Int Source #

The response's http status code.