Skip to content

Starts an asynchronous document classification job using a custom classification model

Description

Starts an asynchronous document classification job using a custom classification model. Use the describe_document_classification_job operation to track the progress of the job.

Usage

comprehend_start_document_classification_job(JobName,
  DocumentClassifierArn, InputDataConfig, OutputDataConfig,
  DataAccessRoleArn, ClientRequestToken, VolumeKmsKeyId, VpcConfig, Tags,
  FlywheelArn)

Arguments

  • JobName

    The identifier of the job.

  • DocumentClassifierArn

    The Amazon Resource Name (ARN) of the document classifier to use to process the job.

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

  • ClientRequestToken

    A unique identifier for the request. If you do not 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 document classification job. For more information, see Amazon VPC.

  • Tags

    Tags to associate with the document classification 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",
  DocumentClassifierArn = "string"
)

Request syntax

svc$start_document_classification_job(
  JobName = "string",
  DocumentClassifierArn = "string",
  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",
  ClientRequestToken = "string",
  VolumeKmsKeyId = "string",
  VpcConfig = list(
    SecurityGroupIds = list(
      "string"
    ),
    Subnets = list(
      "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  FlywheelArn = "string"
)