View a markdown version of this page

AWS::Comprehend::DocumentClassificationJob InputDataConfig - AWS CloudFormation
SyntaxProperties

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 InputDataConfig

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

Syntax

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

JSON

{
  "InputFormat" : String,
  "S3Uri" : String
}

YAML

  InputFormat: String
  S3Uri: String

Properties

InputFormat

Specifies how the text in an input file should be processed:

  • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

  • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

Required: No

Type: String

Allowed values: ONE_DOC_PER_FILE | ONE_DOC_PER_LINE

Update requires: Replacement

S3Uri

The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

Required: Yes

Type: String

Pattern: ^s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?$

Maximum: 1024

Update requires: Replacement