--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_comprehend_key_phrases_detection_job{% #aws_comprehend_key_phrases_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 key phrases detection job completed. ## `input_data_config`{% #input_data_config %} **Type**: `STRUCT`**Provider name**: `InputDataConfig`**Description**: The input data configuration that you supplied when you created the key phrases 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 key phrases 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::comprehend:::key-phrases-detection-job/` The following is an example job ARN: `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab` ## `job_id`{% #job_id %} **Type**: `STRING`**Provider name**: `JobId`**Description**: The identifier assigned to the key phrases detection job. ## `job_name`{% #job_name %} **Type**: `STRING`**Provider name**: `JobName`**Description**: The name that you assigned the key phrases detection job. ## `job_status`{% #job_status %} **Type**: `STRING`**Provider name**: `JobStatus`**Description**: The current status of the key phrases 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. ## `output_data_config`{% #output_data_config %} **Type**: `STRUCT`**Provider name**: `OutputDataConfig`**Description**: The output data configuration that you supplied when you created the key phrases 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. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3. The KmsKeyId can be one of the following formats: - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"` - KMS Key Alias: `"alias/ExampleAlias"` - ARN of a KMS Key Alias: `"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"` - `s3_uri`**Type**: `STRING`**Provider name**: `S3Uri`**Description**: When you use the `OutputDataConfig` object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file. When the topic detection job is finished, the service creates an output file in a directory specific to the job. The `S3Uri` field contains the location of the output file, called `output.tar.gz`. It is a compressed archive that contains the ouput of the operation. 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. ## `submit_time`{% #submit_time %} **Type**: `TIMESTAMP`**Provider name**: `SubmitTime`**Description**: The time that the key phrases detection job was submitted for processing. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `volume_kms_key_id`{% #volume_kms_key_id %} **Type**: `STRING`**Provider name**: `VolumeKmsKeyId`**Description**: ID for the KMS key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats: - KMS Key ID: `"1234abcd-12ab-34cd-56ef-1234567890ab"` - Amazon Resource Name (ARN) of a KMS Key: `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"` ## `vpc_config`{% #vpc_config %} **Type**: `STRUCT`**Provider name**: `VpcConfig`**Description**: Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see [Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html). - `security_group_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `SecurityGroupIds`**Description**: The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you'll be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more information, see [Security Groups for your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html). - `subnets`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `Subnets`**Description**: The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC's Region. This ID number is preceded by "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see [VPCs and Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html).