View a markdown version of this page

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

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

Syntax

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

JSON

{
  "Type" : "AWS::Comprehend::TargetedSentimentDetectionJob",
  "Properties" : {
      "DataAccessRoleArn" : String,
      "InputDataConfig" : InputDataConfig,
      "JobName" : String,
      "LanguageCode" : String,
      "Tags" : [ TagsItems, ... ],
      "VolumeKmsKeyId" : String
    }
}

YAML

Type: AWS::Comprehend::TargetedSentimentDetectionJob
Properties:
  DataAccessRoleArn: String
  InputDataConfig: 
    InputDataConfig
  JobName: String
  LanguageCode: String
  Tags: 
    - TagsItems
  VolumeKmsKeyId: String

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 properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

Required: Yes

Type: InputDataConfig

Update requires: Replacement

JobName

The name that you assigned to the targeted 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 TagsItems

Maximum: 50

Update requires: Replacement

VolumeKmsKeyId

ID for the AWS KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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"

Required: No

Type: String

Pattern: ^\p{ASCII}+$

Maximum: 2048

Update requires: Replacement

Return values

Ref

Fn::GetAtt

EndTime

The time that the targeted sentiment detection job ended.

JobArn

The Amazon Resource Name (ARN) of the targeted sentiment detection 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>:targeted-sentiment-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

JobId

The identifier assigned to the targeted sentiment detection job.

JobStatus

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

SubmitTime

The time that the targeted sentiment detection job was submitted for processing.