Class: Aws::ComprehendMedical::Types::StartPHIDetectionJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::ComprehendMedical::Types::StartPHIDetectionJobRequest

Defined in:

gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.

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

• #kms_key ⇒ String

  An AWS Key Management Service key to encrypt your output files.

• #language_code ⇒ String

  The language of the input documents.

• #output_data_config ⇒ Types::OutputDataConfig

  Specifies where to send the output files.

Instance Attribute Details

#client_request_token ⇒ String

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)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

class StartPHIDetectionJobRequest < 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 Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

Returns:

• (String)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

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

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

Returns:

• (Types::InputDataConfig)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

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

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

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

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

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

Returns:

• (String)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

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

Specifies where to send the output files.

Returns:

• (Types::OutputDataConfig)

# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/types.rb', line 1820

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