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

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::DocumentClassificationJobProperties

Includes:

Structure

Defined in:

lib/aws-sdk-comprehend/types.rb

Overview

Provides information about a document classification job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_access_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the 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.

• #end_time ⇒ Time

  The time that the document classification job completed.

• #flywheel_arn ⇒ String

  The Amazon Resource Number (ARN) of the flywheel.

• #input_data_config ⇒ Types::InputDataConfig

  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.

• #job_id ⇒ String

  The identifier assigned to the document classification job.

• #job_name ⇒ String

  The name that you assigned to the document classification job.

• #job_status ⇒ String

  The current status of the document classification job.

• #message ⇒ 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.

• #submit_time ⇒ 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.

• #vpc_config ⇒ Types::VpcConfig

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

Instance Attribute Details

#data_access_role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#document_classifier_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The time that the document classification job completed.

Returns:

• (Time)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#flywheel_arn ⇒ String

The Amazon Resource Number (ARN) of the flywheel

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

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

Returns:

• (Types::InputDataConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The identifier assigned to the document classification job.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The name that you assigned to the document classification job.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A description of the status of the job.

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

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

Returns:

• (Types::OutputDataConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#submit_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#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”`

Returns:

• (String)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html

Returns:

• (Types::VpcConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 2826

class DocumentClassificationJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :document_classifier_arn,
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end