Skip to content

Starts an asynchronous entity detection job for a collection of documents

Description

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

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

Usage

comprehend_start_entities_detection_job(InputDataConfig,
  OutputDataConfig, DataAccessRoleArn, JobName, EntityRecognizerArn,
  LanguageCode, ClientRequestToken, VolumeKmsKeyId, VpcConfig, Tags,
  FlywheelArn)

Arguments

  • InputDataConfig

    [required] Specifies the format and location of the input data for the job.

  • OutputDataConfig

    [required] Specifies where to send the output files.

  • DataAccessRoleArn

    [required] The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

  • JobName

    The identifier of the job.

  • EntityRecognizerArn

    The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the start_entities_detection_job. This ARN is optional and is only used for a custom entity recognition job.

  • LanguageCode

    [required] The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

  • ClientRequestToken

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

  • VolumeKmsKeyId

    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

    • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • VpcConfig

    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

  • Tags

    Tags to associate with the entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

  • FlywheelArn

    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.

Value

A list with the following syntax:

list(
  JobId = "string",
  JobArn = "string",
  JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
  EntityRecognizerArn = "string"
)

Request syntax

svc$start_entities_detection_job(
  InputDataConfig = list(
    S3Uri = "string",
    InputFormat = "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE",
    DocumentReaderConfig = list(
      DocumentReadAction = "TEXTRACT_DETECT_DOCUMENT_TEXT"|"TEXTRACT_ANALYZE_DOCUMENT",
      DocumentReadMode = "SERVICE_DEFAULT"|"FORCE_DOCUMENT_READ_ACTION",
      FeatureTypes = list(
        "TABLES"|"FORMS"
      )
    )
  ),
  OutputDataConfig = list(
    S3Uri = "string",
    KmsKeyId = "string"
  ),
  DataAccessRoleArn = "string",
  JobName = "string",
  EntityRecognizerArn = "string",
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW",
  ClientRequestToken = "string",
  VolumeKmsKeyId = "string",
  VpcConfig = list(
    SecurityGroupIds = list(
      "string"
    ),
    Subnets = list(
      "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  FlywheelArn = "string"
)