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

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

Overview

Describes information about an entity recognizer.

See Also:

Constant Summary collapse

SENSITIVE = 
[:recognizer_metadata]

Instance Attribute Summary collapse

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) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#end_time ⇒ Time

The time that the recognizer creation completed.

Returns:

  • (Time) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#entity_recognizer_arn ⇒ String

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

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#flywheel_arn ⇒ String

The Amazon Resource Number (ARN) of the flywheel

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#input_data_config ⇒ Types::EntityRecognizerInputDataConfig

The input data properties of an entity recognizer.

Returns:



4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#language_code ⇒ String

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

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#message ⇒ String

A description of the status of the recognizer.

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#model_kms_key_id ⇒ String

ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#output_data_config ⇒ Types::EntityRecognizerOutputDataConfig

Output data configuration.

Returns:



4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#recognizer_metadata ⇒ Types::EntityRecognizerMetadata

Provides information about an entity recognizer.

Returns:



4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#source_model_arn ⇒ String

The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#status ⇒ String

Provides the status of the entity recognizer.

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#submit_time ⇒ Time

The time that the recognizer was submitted for processing.

Returns:

  • (Time) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#training_end_time ⇒ Time

The time that training of the entity recognizer was completed.

Returns:

  • (Time) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#training_start_time ⇒ Time

The time that training of the entity recognizer started.

Returns:

  • (Time) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end

#version_name ⇒ String

The version name you assigned to the entity recognizer.

Returns:

  • (String) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  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) 


4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  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 custom entity recognizer. For more information, see [Amazon VPC].

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

Returns:



4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
 
# File 'lib/aws-sdk-comprehend/types.rb', line 4375

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,
  :model_kms_key_id,
  :version_name,
  :source_model_arn,
  :flywheel_arn,
  :output_data_config)
  SENSITIVE = [:recognizer_metadata]
  include Aws::Structure
end