Class: Aws::Comprehend::Types::EntityRecognizerProperties

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

Overview

Describes information about an entity recognizer.

Constant Summary collapse

SENSITIVE =
[:recognizer_metadata]

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arnString

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

Returns:

  • (String)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#end_timeTime

The time that the recognizer creation completed.

Returns:

  • (Time)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#entity_recognizer_arnString

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

Returns:

  • (String)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#input_data_configTypes::EntityRecognizerInputDataConfig

The input data properties of an entity recognizer.



2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#language_codeString

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Returns:

  • (String)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#messageString

A description of the status of the recognizer.

Returns:

  • (String)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#recognizer_metadataTypes::EntityRecognizerMetadata

Provides information about an entity recognizer.



2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#statusString

Provides the status of the entity recognizer.

Returns:

  • (String)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#submit_timeTime

The time that the recognizer was submitted for processing.

Returns:

  • (Time)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#training_end_timeTime

The time that training of the entity recognizer was completed.

Returns:

  • (Time)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#training_start_timeTime

The time that training of the entity recognizer started.

Returns:

  • (Time)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  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)


2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

Returns:



2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 2962

class EntityRecognizerProperties < Struct.new(
  :entity_recognizer_arn,
  :language_code,
  :status,
  :message,
  :submit_time,
  :end_time,
  :training_start_time,
  :training_end_time,
  :input_data_config,
  :recognizer_metadata,
  :data_access_role_arn,
  :volume_kms_key_id,
  :vpc_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end