Skip to content
AWS for Query.Farm

aws.comprehend.describe_entities_detection_job

Example SQL Queries

SELECT * FROM
aws.comprehend.describe_entities_detection_job
WHERE
"job_id" = 'VALUE';

Description

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

The identifier that Amazon Comprehend generated for the job. The StartEntitiesDetectionJob operation returns this identifier in its response.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
entities_detection_job_properties

An object that contains the properties associated with an entities detection job.

STRUCT(
    "job_id" VARCHAR,
    "job_arn" VARCHAR,
    "job_name" VARCHAR,
    "job_status" VARCHAR,
    "message" VARCHAR,
    "submit_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "entity_recognizer_arn" VARCHAR,
    "input_data_config" STRUCT(
        "s3_uri" VARCHAR,
        "input_format" VARCHAR,
        "document_reader_config" STRUCT(
            "document_read_action" VARCHAR,
            "document_read_mode" VARCHAR,
            "feature_types" VARCHAR[]
        )
    ),
    "output_data_config" STRUCT(
        "s3_uri" VARCHAR,
        "kms_key_id" VARCHAR
    ),
    "language_code" VARCHAR,
    "data_access_role_arn" VARCHAR,
    "volume_kms_key_id" VARCHAR,
    "vpc_config" STRUCT(
        "security_group_ids" VARCHAR[],
        "subnets" VARCHAR[]
    ),
    "flywheel_arn" VARCHAR
)
Show child fields
entities_detection_job_properties.data_access_role_arn

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

entities_detection_job_properties.end_time

The time that the entities detection job completed

entities_detection_job_properties.entity_recognizer_arn

The Amazon Resource Name (ARN) that identifies the entity recognizer.

entities_detection_job_properties.flywheel_arn

The Amazon Resource Name (ARN) of the flywheel associated with this job.

entities_detection_job_properties.input_data_config

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

Show child fields
entities_detection_job_properties.input_data_config.document_reader_config

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

Show child fields
entities_detection_job_properties.input_data_config.document_reader_config.document_read_action

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.

entities_detection_job_properties.input_data_config.document_reader_config.document_read_mode

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.

entities_detection_job_properties.input_data_config.document_reader_config.feature_types[]
entities_detection_job_properties.input_data_config.input_format

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.

entities_detection_job_properties.input_data_config.s3_uri

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.

entities_detection_job_properties.job_arn

The Amazon Resource Name (ARN) of the 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>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

entities_detection_job_properties.job_id

The identifier assigned to the entities detection job.

entities_detection_job_properties.job_name

The name that you assigned the entities detection job.

entities_detection_job_properties.job_status

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

entities_detection_job_properties.language_code

The language code of the input documents.

entities_detection_job_properties.message

A description of the status of a job.

entities_detection_job_properties.output_data_config

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

Show child fields
entities_detection_job_properties.output_data_config.kms_key_id

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"

entities_detection_job_properties.output_data_config.s3_uri

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.

entities_detection_job_properties.submit_time

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

entities_detection_job_properties.volume_kms_key_id

ID for the Amazon Web Services Key Management Service (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"

entities_detection_job_properties.vpc_config

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

Show child fields
entities_detection_job_properties.vpc_config.security_group_ids[]
entities_detection_job_properties.vpc_config.subnets[]