phi_detection_jobs

Creates, updates, deletes, gets or lists a phi_detection_jobs resource.

Overview

Name	phi_detection_jobs
Type	Resource
Id	aws.comprehendmedical.phi_detection_jobs

Fields

The following fields are returned by SELECT queries:

describe_phi_detection_job

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
end_time	string (date-time)	The time that the detection job completed.
expiration_time	string (date-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.
input_data_config	object	The input data configuration that you supplied when you created the detection job.
job_id	string	The identifier assigned to the detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name that you assigned to the detection job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure. (SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED)
kms_key	string	The AWS Key Management Service key, if any, used to encrypt the output files. (pattern: <code>.*</code>)
language_code	string	The language code of the input documents. (en)
manifest_file_path	string	The path to the file that describes the results of a batch job.
message	string	A description of the status of a job.
model_version	string	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.
output_data_config	object	The output data configuration that you supplied when you created the detection job.
submit_time	string (date-time)	The time that the detection job was submitted for processing.

list_phi_detection_jobs

Name	Datatype	Description
comprehend_medical_async_job_properties_list	array	A list containing the properties of each job returned.
next_token	string	Identifies the next page of results to return.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_phi_detection_job	select	region		Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
list_phi_detection_jobs	select	region		Gets a list of protected health information (PHI) detection jobs you have submitted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_phi_detection_job

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

SELECT
data_access_role_arn,
end_time,
expiration_time,
input_data_config,
job_id,
job_name,
job_status,
kms_key,
language_code,
manifest_file_path,
message,
model_version,
output_data_config,
submit_time
FROM aws.comprehendmedical.phi_detection_jobs
WHERE region = '{{ region }}' -- required
;

list_phi_detection_jobs

Gets a list of protected health information (PHI) detection jobs you have submitted.

SELECT
comprehend_medical_async_job_properties_list,
next_token
FROM aws.comprehendmedical.phi_detection_jobs
WHERE region = '{{ region }}' -- required
;