---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# aws_comprehend_pii_entities_detection_job{% #aws_comprehend_pii_entities_detection_job %}

## `account_id`{% #account_id %}

**Type**: `STRING`

## `data_access_role_arn`{% #data_access_role_arn %}

**Type**: `STRING`**Provider name**: `DataAccessRoleArn`**Description**: The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

## `end_time`{% #end_time %}

**Type**: `TIMESTAMP`**Provider name**: `EndTime`**Description**: The time that the PII entities detection job completed.

## `input_data_config`{% #input_data_config %}

**Type**: `STRUCT`**Provider name**: `InputDataConfig`**Description**: The input properties for a PII entities detection job.

- `document_reader_config`**Type**: `STRUCT`**Provider name**: `DocumentReaderConfig`**Description**: Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.
  - `document_read_action`**Type**: `STRING`**Provider name**: `DocumentReadAction`**Description**: This field defines the Amazon Textract API operation that Amazon Comprehend uses to extract text from PDF files and image files. Enter one of the following values:
    - `TEXTRACT_DETECT_DOCUMENT_TEXT` - The Amazon Comprehend service uses the `DetectDocumentText` API operation.
    - `TEXTRACT_ANALYZE_DOCUMENT` - The Amazon Comprehend service uses the `AnalyzeDocument` API operation.
  - `document_read_mode`**Type**: `STRING`**Provider name**: `DocumentReadMode`**Description**: Determines the text extraction actions for PDF files. Enter one of the following values:
    - `SERVICE_DEFAULT` - use the Amazon Comprehend service defaults for PDF files.
    - `FORCE_DOCUMENT_READ_ACTION` - Amazon Comprehend uses the Textract API specified by DocumentReadAction for all PDF files, including digital PDF files.
  - `feature_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `FeatureTypes`**Description**: Specifies the type of Amazon Textract features to apply. If you chose `TEXTRACT_ANALYZE_DOCUMENT` as the read action, you must specify one or both of the following values:
    - `TABLES` - Returns additional information about any tables that are detected in the input document.
    - `FORMS` - Returns additional information about any forms that are detected in the input document.
- `input_format`**Type**: `STRING`**Provider name**: `InputFormat`**Description**: Specifies how the text in an input file should be processed:
  - `ONE_DOC_PER_FILE` - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
  - `ONE_DOC_PER_LINE` - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.
- `s3_uri`**Type**: `STRING`**Provider name**: `S3Uri`**Description**: The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. For example, if you use the URI `S3://bucketName/prefix`, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

## `job_arn`{% #job_arn %}

**Type**: `STRING`**Provider name**: `JobArn`**Description**: 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`

## `job_id`{% #job_id %}

**Type**: `STRING`**Provider name**: `JobId`**Description**: The identifier assigned to the PII entities detection job.

## `job_name`{% #job_name %}

**Type**: `STRING`**Provider name**: `JobName`**Description**: The name that you assigned the PII entities detection job.

## `job_status`{% #job_status %}

**Type**: `STRING`**Provider name**: `JobStatus`**Description**: The current status of the PII entities detection job. If the status is `FAILED`, the `Message` field shows the reason for the failure.

## `language_code`{% #language_code %}

**Type**: `STRING`**Provider name**: `LanguageCode`**Description**: The language code of the input documents.

## `message`{% #message %}

**Type**: `STRING`**Provider name**: `Message`**Description**: A description of the status of a job.

## `mode`{% #mode %}

**Type**: `STRING`**Provider name**: `Mode`**Description**: Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

## `output_data_config`{% #output_data_config %}

**Type**: `STRUCT`**Provider name**: `OutputDataConfig`**Description**: The output data configuration that you supplied when you created the PII entities detection job.

- `kms_key_id`**Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
- `s3_uri`**Type**: `STRING`**Provider name**: `S3Uri`**Description**: When you use the `PiiOutputDataConfig` object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with `.out` appended at the end.

## `redaction_config`{% #redaction_config %}

**Type**: `STRUCT`**Provider name**: `RedactionConfig`**Description**: 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.

- `mask_character`**Type**: `STRING`**Provider name**: `MaskCharacter`**Description**: A character that replaces each character in the redacted PII entity.
- `mask_mode`**Type**: `STRING`**Provider name**: `MaskMode`**Description**: Specifies whether the PII entity is redacted with the mask character or the entity type.
- `pii_entity_types`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `PiiEntityTypes`**Description**: An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

## `submit_time`{% #submit_time %}

**Type**: `TIMESTAMP`**Provider name**: `SubmitTime`**Description**: The time that the PII entities detection job was submitted for processing.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`