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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Provides information about a key phrases detection job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arnString

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

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#end_timeTime

The time that the key phrases detection job completed.

Returns:

  • (Time)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#input_data_configTypes::InputDataConfig

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



3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#job_idString

The identifier assigned to the key phrases detection job.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#job_nameString

The name that you assigned the key phrases detection job.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#job_statusString

The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#language_codeString

The language code of the input documents.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#messageString

A description of the status of a job.

Returns:

  • (String)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#output_data_configTypes::OutputDataConfig

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



3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#submit_timeTime

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

Returns:

  • (Time)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#volume_kms_key_idString

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)


3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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

#vpc_configTypes::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:



3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3060

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