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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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

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

Returns:

  • (String) 

1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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_arn ⇒ String

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see [ Role-Based Permissions Required for Asynchronous Operations].

[1]: docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med

Returns:

  • (String) 

1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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_config ⇒ Types::InputDataConfig

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

Returns:


1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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_name ⇒ String

The identifier of the job.

Returns:

  • (String) 

1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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_key ⇒ String

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) 

1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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_code ⇒ String

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

Returns:

  • (String) 

1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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_config ⇒ Types::OutputDataConfig

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

Returns:


1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/aws-sdk-comprehendmedical/types.rb', line 1691

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