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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

Creating a Request

data DescribePiiEntitiesDetectionJob Source #

See: newDescribePiiEntitiesDetectionJob smart constructor.

Constructors

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

Instances

Instances details

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

newDescribePiiEntitiesDetectionJob Source #

Arguments

:: Text	`DescribePiiEntitiesDetectionJob`
-> DescribePiiEntitiesDetectionJob

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

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

Request Lenses

describePiiEntitiesDetectionJob_jobId :: Lens' DescribePiiEntitiesDetectionJob Text Source #

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

Destructuring the Response

data DescribePiiEntitiesDetectionJobResponse Source #

See: newDescribePiiEntitiesDetectionJobResponse smart constructor.

Constructors

DescribePiiEntitiesDetectionJobResponse'
Fields piiEntitiesDetectionJobProperties :: Maybe PiiEntitiesDetectionJobProperties httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribePiiEntitiesDetectionJobResponse Source #

Arguments

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

Create a value of DescribePiiEntitiesDetectionJobResponse 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:piiEntitiesDetectionJobProperties:DescribePiiEntitiesDetectionJobResponse', describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties - Undocumented member.

$sel:httpStatus:DescribePiiEntitiesDetectionJobResponse', describePiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

describePiiEntitiesDetectionJobResponse_piiEntitiesDetectionJobProperties :: Lens' DescribePiiEntitiesDetectionJobResponse (Maybe PiiEntitiesDetectionJobProperties) Source #

Undocumented member.

describePiiEntitiesDetectionJobResponse_httpStatus :: Lens' DescribePiiEntitiesDetectionJobResponse Int Source #

The response's http status code.