Class: Aws::Comprehend::Types::StartEntitiesDetectionJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::Comprehend::Types::StartEntitiesDetectionJobRequest

Defined in:

gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A unique identifier for the request.

• #data_access_role_arn ⇒ String

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

• #entity_recognizer_arn ⇒ String

  The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob.

• #flywheel_arn ⇒ String

  The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

• #input_data_config ⇒ Types::InputDataConfig

  Specifies the format and location of the input data for the job.

• #job_name ⇒ String

  The identifier of the job.

• #language_code ⇒ String

  The language of the input documents.

• #output_data_config ⇒ Types::OutputDataConfig

  Specifies where to send the output files.

• #tags ⇒ Array<Types::Tag>

  Tags to associate with the entities detection job.

• #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.

• #vpc_config ⇒ Types::VpcConfig

  Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job.

Instance Attribute Details

#client_request_token ⇒ String

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#entity_recognizer_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#flywheel_arn ⇒ String

The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_config ⇒ Types::InputDataConfig

Specifies the format and location of the input data for the job.

Returns:

• (Types::InputDataConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

The identifier of the job.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Returns:

• (String)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

Specifies where to send the output files.

Returns:

• (Types::OutputDataConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Tags to associate with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

Returns:

• (Types::VpcConfig)

# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7071

class StartEntitiesDetectionJobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :entity_recognizer_arn,
  :language_code,
  :client_request_token,
  :volume_kms_key_id,
  :vpc_config,
  :tags,
  :flywheel_arn)
  SENSITIVE = []
  include Aws::Structure
end