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

Class: Aws::Comprehend::Types::KeyPhrasesDetectionJobProperties

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

Overview

Provides information about a key phrases detection job.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

#end_time ⇒ Time

The time that the key phrases detection job completed.

Returns:

  • (Time) —

    The time that the key phrases detection job completed.

#input_data_config ⇒ Types::InputDataConfig

The input data configuration that you supplied when you created the key phrases detection job.

Returns:

  • (Types::InputDataConfig) —

    The input data configuration that you supplied when you created the key phrases detection job.

#job_id ⇒ String

The identifier assigned to the key phrases detection job.

Returns:

  • (String) —

    The identifier assigned to the key phrases detection job.

#job_name ⇒ String

The name that you assigned the key phrases detection job.

Returns:

  • (String) —

    The name that you assigned the key phrases detection job.

#job_status ⇒ String

The current status of the key phrases detection 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 key phrases detection job.

#language_code ⇒ String

The language code of the input documents.

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

Returns:

  • (String) —

    The language code of the input documents.

#message ⇒ String

A description of the status of a job.

Returns:

  • (String) —

    A description of the status of a job.

#output_data_config ⇒ Types::OutputDataConfig

The output data configuration that you supplied when you created the key phrases detection job.

Returns:

  • (Types::OutputDataConfig) —

    The output data configuration that you supplied when you created the key phrases detection job.

#submit_time ⇒ Time

The time that the key phrases detection job was submitted for processing.

Returns:

  • (Time) —

    The time that the key phrases detection 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 key phrases detection 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 key phrases detection job.