Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Documentation

data PiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

See: newPiiEntitiesDetectionJobProperties smart constructor.

Constructors

PiiEntitiesDetectionJobProperties'

Fields

• dataAccessRoleArn :: Maybe Text

  The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

• endTime :: Maybe POSIX

  The time that the PII entities detection job completed.

• inputDataConfig :: Maybe InputDataConfig

  The input properties for a PII entities detection job.

• jobArn :: Maybe Text

  The Amazon Resource Name (ARN) of the PII entities 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

• jobId :: Maybe Text

  The identifier assigned to the PII entities detection job.

• jobName :: Maybe Text

  The name that you assigned the PII entities detection job.

• jobStatus :: Maybe JobStatus

  The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

• languageCode :: Maybe LanguageCode

  The language code of the input documents

• message :: Maybe Text

  A description of the status of a job.

• mode :: Maybe PiiEntitiesDetectionMode

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

• outputDataConfig :: Maybe PiiOutputDataConfig

  The output data configuration that you supplied when you created the PII entities detection 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.

• submitTime :: Maybe POSIX

  The time that the PII entities detection job was submitted for processing.

Instances

FromJSON PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Methods

parseJSON :: Value -> Parser PiiEntitiesDetectionJobProperties

parseJSONList :: Value -> Parser [PiiEntitiesDetectionJobProperties]

Generic PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Associated Types

type Rep PiiEntitiesDetectionJobProperties :: Type -> Type

Methods

from :: PiiEntitiesDetectionJobProperties -> Rep PiiEntitiesDetectionJobProperties x

to :: Rep PiiEntitiesDetectionJobProperties x -> PiiEntitiesDetectionJobProperties

Read PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Methods

readsPrec :: Int -> ReadS PiiEntitiesDetectionJobProperties

readList :: ReadS [PiiEntitiesDetectionJobProperties]

readPrec :: ReadPrec PiiEntitiesDetectionJobProperties

readListPrec :: ReadPrec [PiiEntitiesDetectionJobProperties]

Show PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Methods

showsPrec :: Int -> PiiEntitiesDetectionJobProperties -> ShowS

show :: PiiEntitiesDetectionJobProperties -> String

showList :: [PiiEntitiesDetectionJobProperties] -> ShowS

NFData PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Methods

rnf :: PiiEntitiesDetectionJobProperties -> ()

Eq PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Methods

(==) :: PiiEntitiesDetectionJobProperties -> PiiEntitiesDetectionJobProperties -> Bool

(/=) :: PiiEntitiesDetectionJobProperties -> PiiEntitiesDetectionJobProperties -> Bool

Hashable PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

Methods

hashWithSalt :: Int -> PiiEntitiesDetectionJobProperties -> Int

hash :: PiiEntitiesDetectionJobProperties -> Int

type Rep PiiEntitiesDetectionJobProperties

Defined in Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties

type Rep PiiEntitiesDetectionJobProperties = D1 ('MetaData "PiiEntitiesDetectionJobProperties" "Amazonka.Comprehend.Types.PiiEntitiesDetectionJobProperties" "amazonka-comprehend-2.0-Ko6GCjAQF2RARapSdPn69F" 'False) (C1 ('MetaCons "PiiEntitiesDetectionJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig)))) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionMode)) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiOutputDataConfig))) :*: (S1 ('MetaSel ('Just "redactionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RedactionConfig)) :*: S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))))

newPiiEntitiesDetectionJobProperties :: PiiEntitiesDetectionJobProperties

Create a value of PiiEntitiesDetectionJobProperties 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:dataAccessRoleArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

$sel:endTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_endTime - The time that the PII entities detection job completed.

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

$sel:jobArn:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobArn - The Amazon Resource Name (ARN) of the PII entities 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:jobId:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobId - The identifier assigned to the PII entities detection job.

$sel:jobName:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobName - The name that you assigned the PII entities detection job.

$sel:jobStatus:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_jobStatus - The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

$sel:languageCode:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_languageCode - The language code of the input documents

$sel:message:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_message - A description of the status of a job.

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

$sel:outputDataConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_outputDataConfig - The output data configuration that you supplied when you created the PII entities detection job.

$sel:redactionConfig:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_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:submitTime:PiiEntitiesDetectionJobProperties', piiEntitiesDetectionJobProperties_submitTime - The time that the PII entities detection job was submitted for processing.

piiEntitiesDetectionJobProperties_dataAccessRoleArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

piiEntitiesDetectionJobProperties_endTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime)

The time that the PII entities detection job completed.

piiEntitiesDetectionJobProperties_inputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe InputDataConfig)

The input properties for a PII entities detection job.

piiEntitiesDetectionJobProperties_jobArn :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)

The Amazon Resource Name (ARN) of the PII entities 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

piiEntitiesDetectionJobProperties_jobId :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)

The identifier assigned to the PII entities detection job.

piiEntitiesDetectionJobProperties_jobName :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)

The name that you assigned the PII entities detection job.

piiEntitiesDetectionJobProperties_jobStatus :: Lens' PiiEntitiesDetectionJobProperties (Maybe JobStatus)

The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

piiEntitiesDetectionJobProperties_languageCode :: Lens' PiiEntitiesDetectionJobProperties (Maybe LanguageCode)

The language code of the input documents

piiEntitiesDetectionJobProperties_message :: Lens' PiiEntitiesDetectionJobProperties (Maybe Text)

A description of the status of a job.

piiEntitiesDetectionJobProperties_mode :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiEntitiesDetectionMode)

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

piiEntitiesDetectionJobProperties_outputDataConfig :: Lens' PiiEntitiesDetectionJobProperties (Maybe PiiOutputDataConfig)

The output data configuration that you supplied when you created the PII entities detection job.

piiEntitiesDetectionJobProperties_redactionConfig :: Lens' PiiEntitiesDetectionJobProperties (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.

piiEntitiesDetectionJobProperties_submitTime :: Lens' PiiEntitiesDetectionJobProperties (Maybe UTCTime)

The time that the PII entities detection job was submitted for processing.