Class: Aws::Comprehend::Types::EntitiesDetectionJobProperties

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

Overview

Provides information about an entities 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)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job completed

Returns:

  • (Time)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

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

#entity_recognizer_arnString

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Returns:

  • (String)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job.



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

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

#job_arnString

The Amazon Resource Name (ARN) of the entities detection 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>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Returns:

  • (String)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job.

Returns:

  • (String)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job.

Returns:

  • (String)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

Returns:

  • (String)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job.



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entities detection job was submitted for processing.

Returns:

  • (Time)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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)


3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

class EntitiesDetectionJobProperties < Struct.new(
  :job_id,
  :job_arn,
  :job_name,
  :job_status,
  :message,
  :submit_time,
  :end_time,
  :entity_recognizer_arn,
  :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 entity detection job. For more information, see Amazon VPC.

Returns:



3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 3083

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