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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous PII entity detection job for a collection of documents.

Synopsis

Creating a Request

data StartPiiEntitiesDetectionJob Source #

See: newStartPiiEntitiesDetectionJob smart constructor.

Constructors

StartPiiEntitiesDetectionJob'

Fields

jobName :: Maybe Text
The identifier of the job.
redactionConfig :: Maybe RedactionConfig
Provides configuration parameters for PII entity redaction.
This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.
clientRequestToken :: Maybe Text
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
tags :: Maybe [Tag]
Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
inputDataConfig :: InputDataConfig
The input properties for a PII entities detection job.
outputDataConfig :: OutputDataConfig
Provides conﬁguration parameters for the output of PII entity detection jobs.
mode :: PiiEntitiesDetectionMode
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
dataAccessRoleArn :: Text
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
languageCode :: LanguageCode
The language of the input documents.

Instances

Instances details

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

newStartPiiEntitiesDetectionJob Source #

Arguments

:: InputDataConfig	`$sel:inputDataConfig:StartPiiEntitiesDetectionJob'`
-> OutputDataConfig	`$sel:outputDataConfig:StartPiiEntitiesDetectionJob'`
-> PiiEntitiesDetectionMode	`$sel:mode:StartPiiEntitiesDetectionJob'`
-> Text	`$sel:dataAccessRoleArn:StartPiiEntitiesDetectionJob'`
-> LanguageCode	`$sel:languageCode:StartPiiEntitiesDetectionJob'`
-> StartPiiEntitiesDetectionJob

Create a value of StartPiiEntitiesDetectionJob 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:jobName:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_jobName - The identifier of the job.

$sel:redactionConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_redactionConfig - Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

$sel:clientRequestToken:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

$sel:tags:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_tags - Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

$sel:inputDataConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_inputDataConfig - The input properties for a PII entities detection job.

$sel:outputDataConfig:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_outputDataConfig - Provides conﬁguration parameters for the output of PII entity detection jobs.

$sel:mode:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_mode - Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

$sel:dataAccessRoleArn:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

$sel:languageCode:StartPiiEntitiesDetectionJob', startPiiEntitiesDetectionJob_languageCode - The language of the input documents.

Request Lenses

startPiiEntitiesDetectionJob_jobName :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) Source #

The identifier of the job.

startPiiEntitiesDetectionJob_redactionConfig :: Lens' StartPiiEntitiesDetectionJob (Maybe RedactionConfig) Source #

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

startPiiEntitiesDetectionJob_clientRequestToken :: Lens' StartPiiEntitiesDetectionJob (Maybe Text) Source #

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

startPiiEntitiesDetectionJob_tags :: Lens' StartPiiEntitiesDetectionJob (Maybe [Tag]) Source #

Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

startPiiEntitiesDetectionJob_inputDataConfig :: Lens' StartPiiEntitiesDetectionJob InputDataConfig Source #

The input properties for a PII entities detection job.

startPiiEntitiesDetectionJob_outputDataConfig :: Lens' StartPiiEntitiesDetectionJob OutputDataConfig Source #

Provides conﬁguration parameters for the output of PII entity detection jobs.

startPiiEntitiesDetectionJob_mode :: Lens' StartPiiEntitiesDetectionJob PiiEntitiesDetectionMode Source #

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

startPiiEntitiesDetectionJob_dataAccessRoleArn :: Lens' StartPiiEntitiesDetectionJob Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

startPiiEntitiesDetectionJob_languageCode :: Lens' StartPiiEntitiesDetectionJob LanguageCode Source #

The language of the input documents.

Destructuring the Response

data StartPiiEntitiesDetectionJobResponse Source #

See: newStartPiiEntitiesDetectionJobResponse smart constructor.

Constructors

StartPiiEntitiesDetectionJobResponse'

Fields

jobId :: Maybe Text
The identifier generated for the job.
jobArn :: Maybe Text
The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
```
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
```
The following is an example job ARN:
```
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
```
jobStatus :: Maybe JobStatus
The status of the job.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newStartPiiEntitiesDetectionJobResponse Source #

Arguments

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

Create a value of StartPiiEntitiesDetectionJobResponse 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:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobId - The identifier generated for the job.

$sel:jobArn:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobArn - The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

$sel:jobStatus:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_jobStatus - The status of the job.

$sel:httpStatus:StartPiiEntitiesDetectionJobResponse', startPiiEntitiesDetectionJobResponse_httpStatus - The response's http status code.

Response Lenses

startPiiEntitiesDetectionJobResponse_jobId :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) Source #

The identifier generated for the job.

startPiiEntitiesDetectionJobResponse_jobArn :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

startPiiEntitiesDetectionJobResponse_jobStatus :: Lens' StartPiiEntitiesDetectionJobResponse (Maybe JobStatus) Source #

The status of the job.

startPiiEntitiesDetectionJobResponse_httpStatus :: Lens' StartPiiEntitiesDetectionJobResponse Int Source #

The response's http status code.