Skip to content

Start Entities Detection V2 Job

comprehendmedical_start_entities_detection_v2_job R Documentation

Starts an asynchronous medical entity detection job for a collection of documents

Description

Starts an asynchronous medical entity detection job for a collection of documents. Use the describe_entities_detection_v2_job operation to track the status of a job.

Usage

comprehendmedical_start_entities_detection_v2_job(InputDataConfig,
  OutputDataConfig, DataAccessRoleArn, JobName, ClientRequestToken,
  KMSKey, LanguageCode)

Arguments

InputDataConfig

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

OutputDataConfig

[required] The output configuration that specifies where to send the output files.

DataAccessRoleArn

[required] 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.

JobName

The identifier of the job.

ClientRequestToken

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

KMSKey

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.

LanguageCode

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

Value

A list with the following syntax: 

list(
  JobId = "string"
)

Request syntax

svc$start_entities_detection_v2_job(
  InputDataConfig = list(
    S3Bucket = "string",
    S3Key = "string"
  ),
  OutputDataConfig = list(
    S3Bucket = "string",
    S3Key = "string"
  ),
  DataAccessRoleArn = "string",
  JobName = "string",
  ClientRequestToken = "string",
  KMSKey = "string",
  LanguageCode = "en"
)