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

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

Overview

Note:

When making an API call, you may pass StartEntitiesDetectionJobRequest data as a hash:

{
  input_data_config: { # required
    s3_uri: "S3Uri", # required
    input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
  },
  output_data_config: { # required
    s3_uri: "S3Uri", # required
    kms_key_id: "KmsKeyId",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  entity_recognizer_arn: "EntityRecognizerArn",
  language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  client_request_token: "ClientRequestTokenString",
  volume_kms_key_id: "KmsKeyId",
  vpc_config: {
    security_group_ids: ["SecurityGroupId"], # required
    subnets: ["SubnetId"], # required
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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)


4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arnString

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Returns:

  • (String)


4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

#entity_recognizer_arnString

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)


4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

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



4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The identifier of the job.

Returns:

  • (String)


4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

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)


4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_configTypes::OutputDataConfig

Specifies where to send the output files.



4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  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)


4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end

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



4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 4779

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)
  SENSITIVE = []
  include Aws::Structure
end