class Aws::Comprehend::Types::DocumentClassificationJobProperties

Provides information about a document classification job.

@!attribute [rw] job_id

The identifier assigned to the document classification job.
@return [String]

@!attribute [rw] job_arn

The Amazon Resource Name (ARN) of the document classification job.
It is a unique, fully qualified identifier for the job. It includes
the AWS account, 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`
@return [String]

@!attribute [rw] job_name

The name that you assigned to the document classification job.
@return [String]

@!attribute [rw] job_status

The current status of the document classification job. If the status
is `FAILED`, the `Message` field shows the reason for the failure.
@return [String]

@!attribute [rw] message

A description of the status of the job.
@return [String]

@!attribute [rw] submit_time

The time that the document classification job was submitted for
processing.
@return [Time]

@!attribute [rw] end_time

The time that the document classification job completed.
@return [Time]

@!attribute [rw] document_classifier_arn

The Amazon Resource Name (ARN) that identifies the document
classifier.
@return [String]

@!attribute [rw] input_data_config

The input data configuration that you supplied when you created the
document classification job.
@return [Types::InputDataConfig]

@!attribute [rw] output_data_config

The output data configuration that you supplied when you created the
document classification job.
@return [Types::OutputDataConfig]

@!attribute [rw] data_access_role_arn

The Amazon Resource Name (ARN) of the AWS identity and Access
Management (IAM) role that grants Amazon Comprehend read access to
your input data.
@return [String]

@!attribute [rw] volume_kms_key_id

ID for the AWS 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"`
@return [String]

@!attribute [rw] vpc_config

Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your document
classification job. For more information, see [Amazon VPC][1].

[1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
@return [Types::VpcConfig]

@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassificationJobProperties AWS API Documentation

Constants

SENSITIVE