Class: Aws::ComprehendMedical::Types::StartEntitiesDetectionV2JobRequest

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

Overview

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 Medical generates one for you.

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

Returns:

  • (String)


1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  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 Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

Returns:

  • (String)


1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#input_data_configTypes::InputDataConfig

The input configuration that specifies the format and location of the input data for the job.



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The identifier of the job.

Returns:

  • (String)


1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#kms_keyString

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

Returns:

  • (String)


1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).

Returns:

  • (String)


1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_configTypes::OutputDataConfig

The output configuration that specifies where to send the output files.



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1683

class StartEntitiesDetectionV2JobRequest < Struct.new(
  :input_data_config,
  :output_data_config,
  :data_access_role_arn,
  :job_name,
  :client_request_token,
  :kms_key,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end