You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartPHIDetectionJobRequest as input to an Aws::Client method, you can use a vanilla 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
}

See Also:

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, Amazon Comprehend Medical generates one.

Returns:

  • (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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

Returns:

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

Returns:

#job_name ⇒ String

The identifier of the job.

Returns:

  • (String) —

    The identifier of the job.

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

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

#language_code ⇒ String

The language of the input documents. All documents must be in the same language.

Possible values:

  • en

Returns:

  • (String) —

    The language of the input documents.

#output_data_config ⇒ Types::OutputDataConfig

Specifies where to send the output files.

Returns: