View a markdown version of this page

AWS::Comprehend::DocumentClassificationJob - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Comprehend::DocumentClassificationJob

The AWS::Comprehend::DocumentClassificationJob resource Property description not available. for Comprehend.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Comprehend::DocumentClassificationJob",
  "Properties" : {
      "DataAccessRoleArn" : String,
      "DocumentClassifierArn" : String,
      "InputDataConfig" : InputDataConfig,
      "JobName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Comprehend::DocumentClassificationJob
Properties:
  DataAccessRoleArn: String
  DocumentClassifierArn: String
  InputDataConfig: 
    InputDataConfig
  JobName: String
  Tags: 
    - Tag

Properties

DataAccessRoleArn

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

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

DocumentClassifierArn

The Amazon Resource Name (ARN) that identifies the document classifier.

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?$

Maximum: 256

Update requires: Replacement

InputDataConfig

The input data configuration that you supplied when you created the document classification job.

Required: Yes

Type: InputDataConfig

Update requires: Replacement

JobName

The name that you assigned to the document classification job.

Required: No

Type: String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Minimum: 1

Maximum: 256

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

JobArn

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully qualified identifier for the job. It includes the AWS account, AWS Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab

JobId

The identifier assigned to the document classification job.

JobStatus

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

SubmitTime

The time that the document classification job was submitted for processing.