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.ComprehendMedical.DescribeEntitiesDetectionV2Job

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeEntitiesDetectionV2Job Source #

See: newDescribeEntitiesDetectionV2Job smart constructor.

Constructors

DescribeEntitiesDetectionV2Job'
Fields jobId :: Text The identifier that Comprehend Medical; generated for the job. The `StartEntitiesDetectionV2Job` operation returns this identifier in its response.

Instances

Instances details

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

newDescribeEntitiesDetectionV2Job Source #

Arguments

:: Text	`DescribeEntitiesDetectionV2Job`
-> DescribeEntitiesDetectionV2Job

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

DescribeEntitiesDetectionV2Job, describeEntitiesDetectionV2Job_jobId - The identifier that Comprehend Medical; generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.

Request Lenses

describeEntitiesDetectionV2Job_jobId :: Lens' DescribeEntitiesDetectionV2Job Text Source #

The identifier that Comprehend Medical; generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.

Destructuring the Response

data DescribeEntitiesDetectionV2JobResponse Source #

See: newDescribeEntitiesDetectionV2JobResponse smart constructor.

Constructors

DescribeEntitiesDetectionV2JobResponse'
Fields comprehendMedicalAsyncJobProperties :: Maybe ComprehendMedicalAsyncJobProperties An object that contains the properties associated with a detection job. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeEntitiesDetectionV2JobResponse Source #

Arguments

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

Create a value of DescribeEntitiesDetectionV2JobResponse 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:comprehendMedicalAsyncJobProperties:DescribeEntitiesDetectionV2JobResponse', describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties - An object that contains the properties associated with a detection job.

$sel:httpStatus:DescribeEntitiesDetectionV2JobResponse', describeEntitiesDetectionV2JobResponse_httpStatus - The response's http status code.

Response Lenses

describeEntitiesDetectionV2JobResponse_comprehendMedicalAsyncJobProperties :: Lens' DescribeEntitiesDetectionV2JobResponse (Maybe ComprehendMedicalAsyncJobProperties) Source #

An object that contains the properties associated with a detection job.

describeEntitiesDetectionV2JobResponse_httpStatus :: Lens' DescribeEntitiesDetectionV2JobResponse Int Source #

The response's http status code.