View a markdown version of this page

AWS::Comprehend::EntityRecognizer EntityRecognizerDocuments - 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::EntityRecognizer EntityRecognizerDocuments

Describes the training documents submitted with an entity recognizer.

Syntax

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

JSON

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

YAML

  InputFormat: String
  S3Uri: String
  TestS3Uri: String

Properties

InputFormat

Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. 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

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling.

Required: Yes

Type: String

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

Maximum: 1024

Update requires: Replacement

TestS3Uri

Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

Required: No

Type: String

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

Maximum: 1024

Update requires: Replacement