Skip to content
AWS for Query.Farm

aws.comprehendmedical.describe_rx_norm_inference_job

Example SQL Queries

SELECT * FROM
aws.comprehendmedical.describe_rx_norm_inference_job
WHERE
"job_id" = 'VALUE';

Description

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob 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
comprehend_medical_async_job_properties

An object that contains the properties associated with a detection job.

STRUCT(
    "job_id" VARCHAR,
    "job_name" VARCHAR,
    "job_status" VARCHAR,
    "message" VARCHAR,
    "submit_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "expiration_time" TIMESTAMP_S,
    "input_data_config" STRUCT(
        "s3_bucket" VARCHAR,
        "s3_key" VARCHAR
    ),
    "output_data_config" STRUCT(
        "s3_bucket" VARCHAR,
        "s3_key" VARCHAR
    ),
    "language_code" VARCHAR,
    "data_access_role_arn" VARCHAR,
    "manifest_file_path" VARCHAR,
    "kms_key" VARCHAR,
    "model_version" VARCHAR
)
Show child fields
comprehend_medical_async_job_properties.data_access_role_arn

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

comprehend_medical_async_job_properties.end_time

The time that the detection job completed.

comprehend_medical_async_job_properties.expiration_time

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

comprehend_medical_async_job_properties.input_data_config

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

Show child fields
comprehend_medical_async_job_properties.input_data_config.s3_bucket

The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.

comprehend_medical_async_job_properties.input_data_config.s3_key

The path to the input data files in the S3 bucket.

comprehend_medical_async_job_properties.job_id

The identifier assigned to the detection job.

comprehend_medical_async_job_properties.job_name

The name that you assigned to the detection job.

comprehend_medical_async_job_properties.job_status

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

comprehend_medical_async_job_properties.kms_key

The AWS Key Management Service key, if any, used to encrypt the output files.

comprehend_medical_async_job_properties.language_code

The language code of the input documents.

comprehend_medical_async_job_properties.manifest_file_path

The path to the file that describes the results of a batch job.

comprehend_medical_async_job_properties.message

A description of the status of a job.

comprehend_medical_async_job_properties.model_version

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

comprehend_medical_async_job_properties.output_data_config

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

Show child fields
comprehend_medical_async_job_properties.output_data_config.s3_bucket

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.

comprehend_medical_async_job_properties.output_data_config.s3_key

The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.

comprehend_medical_async_job_properties.submit_time

The time that the detection job was submitted for processing.