AWSComprehendPiiEntitiesDetectionJobProperties

Objective-C

@interface AWSComprehendPiiEntitiesDetectionJobProperties

Swift

class AWSComprehendPiiEntitiesDetectionJobProperties

Provides information about a PII entities detection job.

  • The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable dataAccessRoleArn;

    Swift

    var dataAccessRoleArn: String? { get set }

  • The time that the PII entities detection job completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTime;

    Swift

    var endTime: Date? { get set }

  • The input properties for a PII entities detection job.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendInputDataConfig *_Nullable inputDataConfig;

    Swift

    var inputDataConfig: AWSComprehendInputDataConfig? { get set }

  • The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobArn;

    Swift

    var jobArn: String? { get set }

  • The identifier assigned to the PII entities detection job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobId;

    Swift

    var jobId: String? { get set }

  • The name that you assigned the PII entities detection job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobName;

    Swift

    var jobName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendJobStatus jobStatus;

    Swift

    var jobStatus: AWSComprehendJobStatus { get set }

  • The language code of the input documents.

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendLanguageCode languageCode;

    Swift

    var languageCode: AWSComprehendLanguageCode { get set }

  • A description of the status of a job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable message;

    Swift

    var message: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendPiiEntitiesDetectionMode mode;

    Swift

    var mode: AWSComprehendPiiEntitiesDetectionMode { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendPiiOutputDataConfig *_Nullable outputDataConfig;

    Swift

    var outputDataConfig: AWSComprehendPiiOutputDataConfig? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSComprehendRedactionConfig *_Nullable redactionConfig;

    Swift

    var redactionConfig: AWSComprehendRedactionConfig? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable submitTime;

    Swift

    var submitTime: Date? { get set }