Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . comprehend ]

start-document-classification-job

Description

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-document-classification-job
[--job-name <value>]
--document-classifier-arn <value>
--input-data-config <value>
--output-data-config <value>
--data-access-role-arn <value>
[--client-request-token <value>]
[--volume-kms-key-id <value>]
[--vpc-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--job-name (string)

The identifier of the job.

--document-classifier-arn (string)

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

--input-data-config (structure)

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

Shorthand Syntax:

S3Uri=string,InputFormat=string

JSON Syntax:

{
  "S3Uri": "string",
  "InputFormat": "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE"
}

--output-data-config (structure)

Specifies where to send the output files.

Shorthand Syntax:

S3Uri=string,KmsKeyId=string

JSON Syntax:

{
  "S3Uri": "string",
  "KmsKeyId": "string"
}

--data-access-role-arn (string)

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

--client-request-token (string)

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

--volume-kms-key-id (string)

ID for the AWS 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"

--vpc-config (structure)

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 .

Shorthand Syntax:

SecurityGroupIds=string,string,Subnets=string,string

JSON Syntax:

{
  "SecurityGroupIds": ["string", ...],
  "Subnets": ["string", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

JobId -> (string)

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

JobStatus -> (string)

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.
  • IN_PROGRESS - Amazon Comprehend is processing the job.
  • COMPLETED - The job was successfully completed and the output is available.
  • FAILED - The job did not complete. For details, use the operation.
  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
  • STOPPED - The job was successfully stopped without completing.