AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ComprehendMedical::Types::StartICD10CMInferenceJobRequest

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

Overview

Note:

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

{
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
}

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.

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

Returns:

  • (String)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

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


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

class StartICD10CMInferenceJobRequest < 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

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



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

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


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

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


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

class StartICD10CMInferenceJobRequest < 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.

Returns:

  • (String)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

class StartICD10CMInferenceJobRequest < 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

Specifies where to send the output files.



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1575

class StartICD10CMInferenceJobRequest < 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