View a markdown version of this page

AWS::Comprehend::SentimentDetectionJob - 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::SentimentDetectionJob

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

Syntax

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

JSON

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

YAML

Type: AWS::Comprehend::SentimentDetectionJob
Properties:
  DataAccessRoleArn: String
  InputDataConfig: 
    InputDataConfig
  JobName: String
  LanguageCode: 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

InputDataConfig

The input data configuration that you supplied when you created the sentiment detection job.

Required: Yes

Type: InputDataConfig

Update requires: Replacement

JobName

The name that you assigned to the sentiment detection job

Required: No

Type: String

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

Minimum: 1

Maximum: 256

Update requires: Replacement

LanguageCode

The language code of the input documents.

Required: Yes

Type: String

Allowed values: en | es | fr | de | it | pt | ar | hi | ja | ko | zh | zh-TW

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

JobId

The identifier assigned to the sentiment detection job.

JobStatus

The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.