View a markdown version of this page

AWS::Comprehend::DominantLanguageDetectionJob - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::Comprehend::DominantLanguageDetectionJob

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

Syntax

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

JSON

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

YAML

Type: AWS::Comprehend::DominantLanguageDetectionJob
Properties:
  DataAccessRoleArn: String
  InputDataConfig: 
    InputDataConfig
  JobName: String
  Tags: 
    - Tag
  VolumeKmsKeyId: String

Properties

DataAccessRoleArn

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

Required: No

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 dominant language detection job.

Required: No

Type: InputDataConfig

Update requires: Replacement

JobName

The name that you assigned to the dominant language detection job.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: Replacement

VolumeKmsKeyId

ID for the Amazon Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis 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

Maximum: 2048

Update requires: Replacement

Return values

Ref

Fn::GetAtt

JobArn

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab

JobId

The identifier assigned to the dominant language detection job.

JobStatus

The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.