AWSComprehendStartPiiEntitiesDetectionJobRequest

Objective-C

@interface AWSComprehendStartPiiEntitiesDetectionJobRequest

Swift

class AWSComprehendStartPiiEntitiesDetectionJobRequest

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

    Declaration

    Objective-C

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

    Swift

    var clientRequestToken: String? { get set }

  • 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 input properties for a PII entities detection job.

    Declaration

    Objective-C

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

    Swift

    var inputDataConfig: AWSComprehendInputDataConfig? { get set }

  • The identifier of the job.

    Declaration

    Objective-C

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

    Swift

    var jobName: String? { get set }

  • The language of the input documents. Enter the language code for English (en) or Spanish (es).

    Declaration

    Objective-C

    @property (nonatomic) AWSComprehendLanguageCode languageCode;

    Swift

    var languageCode: AWSComprehendLanguageCode { 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 }

  • Provides configuration parameters for the output of PII entity detection jobs.

    Declaration

    Objective-C

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

    Swift

    var outputDataConfig: AWSComprehendOutputDataConfig? { 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 }

  • Tags to associate 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSComprehendTag *> *_Nullable tags;

    Swift

    var tags: [AWSComprehendTag]? { get set }