document_classification_jobs

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

Overview

Name	document_classification_jobs
Type	Resource
Id	aws.comprehend.document_classification_jobs

Fields

The following fields are returned by SELECT queries:

describe_document_classification_job

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
document_classifier_arn	string	The Amazon Resource Name (ARN) that identifies the document classifier. (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:document-classifier/[a-zA-Z0-9](-[a-zA-Z0-9])(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*)?</code>)
end_time	string (date-time)	The time that the document classification job completed.
flywheel_arn	string	The Amazon Resource Number (ARN) of the flywheel (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:flywheel/[a-zA-Z0-9](-[a-zA-Z0-9])*</code>)
input_data_config	object	The input data configuration that you supplied when you created the document classification job.
job_arn	string	The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-[a-zA-Z0-9])((/dataset/[a-zA-Z0-9](-[a-zA-Z0-9]))|(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*))?</code>)
job_id	string	The identifier assigned to the document classification job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name that you assigned to the document classification job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)
message	string	A description of the status of the job.
output_data_config	object	The output data configuration that you supplied when you created the document classification job.
submit_time	string (date-time)	The time that the document classification job was submitted for processing.
volume_kms_key_id	string	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" (pattern: <code>^\p{ASCII}+$</code>)
vpc_config	object	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

list_document_classification_jobs

Name	Datatype	Description
data_access_role_arn	string	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. (pattern: <code>arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+</code>)
document_classifier_arn	string	The Amazon Resource Name (ARN) that identifies the document classifier. (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:document-classifier/[a-zA-Z0-9](-[a-zA-Z0-9])(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*)?</code>)
end_time	string (date-time)	The time that the document classification job completed.
flywheel_arn	string	The Amazon Resource Number (ARN) of the flywheel (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:flywheel/[a-zA-Z0-9](-[a-zA-Z0-9])*</code>)
input_data_config	object	The input data configuration that you supplied when you created the document classification job.
job_arn	string	The Amazon Resource Name (ARN) of the document classification 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>:document-classification-job/<job-id> The following is an example job ARN: arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab (pattern: <code>arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-[a-zA-Z0-9])((/dataset/[a-zA-Z0-9](-[a-zA-Z0-9]))|(/version/[a-zA-Z0-9](-[a-zA-Z0-9])*))?</code>)
job_id	string	The identifier assigned to the document classification job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_name	string	The name that you assigned to the document classification job. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
job_status	string	The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure. (SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED)
message	string	A description of the status of the job.
output_data_config	object	The output data configuration that you supplied when you created the document classification job.
submit_time	string (date-time)	The time that the document classification job was submitted for processing.
volume_kms_key_id	string	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" (pattern: <code>^\p{ASCII}+$</code>)
vpc_config	object	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_document_classification_job	select	region		Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.
list_document_classification_jobs	select	region		Gets a list of the documentation classification jobs that 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_document_classification_job

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

SELECT
data_access_role_arn,
document_classifier_arn,
end_time,
flywheel_arn,
input_data_config,
job_arn,
job_id,
job_name,
job_status,
message,
output_data_config,
submit_time,
volume_kms_key_id,
vpc_config
FROM aws.comprehend.document_classification_jobs
WHERE region = '{{ region }}' -- required
;

list_document_classification_jobs

Gets a list of the documentation classification jobs that you have submitted.

SELECT
data_access_role_arn,
document_classifier_arn,
end_time,
flywheel_arn,
input_data_config,
job_arn,
job_id,
job_name,
job_status,
message,
output_data_config,
submit_time,
volume_kms_key_id,
vpc_config
FROM aws.comprehend.document_classification_jobs
WHERE region = '{{ region }}' -- required
;