You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::DocumentClassificationJobProperties

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about a document classification job.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arn ⇒ String

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

Returns:

  • (String) —

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

#document_classifier_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the document classifier.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) that identifies the document classifier.

#end_time ⇒ Time

The time that the document classification job completed.

Returns:

  • (Time) —

    The time that the document classification job completed.

#input_data_config ⇒ Types::InputDataConfig

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

Returns:

  • (Types::InputDataConfig) —

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

#job_id ⇒ String

The identifier assigned to the document classification job.

Returns:

  • (String) —

    The identifier assigned to the document classification job.

#job_name ⇒ String

The name that you assigned to the document classification job.

Returns:

  • (String) —

    The name that you assigned to the document classification job.

#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.

Possible values:

  • SUBMITTED
  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • STOP_REQUESTED
  • STOPPED

Returns:

  • (String) —

    The current status of the document classification job.

#message ⇒ String

A description of the status of the job.

Returns:

  • (String) —

    A description of the status of the job.

#output_data_config ⇒ Types::OutputDataConfig

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

Returns:

  • (Types::OutputDataConfig) —

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

#submit_time ⇒ Time

The time that the document classification job was submitted for processing.

Returns:

  • (Time) —

    The time that the document classification job was submitted for processing.

#volume_kms_key_id ⇒ String

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"

Returns:

  • (String) —

    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.

#vpc_config ⇒ Types::VpcConfig

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.

Returns:

  • (Types::VpcConfig) —

    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job.