View a markdown version of this page

AWS::Connect::Vocabulary - 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::Connect::Vocabulary

Creates a custom vocabulary associated with your Connect Customer instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Connect Customer uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Syntax

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

JSON

{
  "Type" : "AWS::Connect::Vocabulary",
  "Properties" : {
      "Content" : String,
      "InstanceId" : String,
      "LanguageCode" : String,
      "Tags" : [ Tag, ... ],
      "VocabularyName" : String
    }
}

YAML

Type: AWS::Connect::Vocabulary
Properties:
  Content: String
  InstanceId: String
  LanguageCode: String
  Tags: 
    - Tag
  VocabularyName: String

Properties

Content

The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.

Required: Yes

Type: String

Minimum: 1

Maximum: 60000

Update requires: Replacement

InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: Replacement

LanguageCode

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

Required: Yes

Type: String

Allowed values: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN | en-NZ | en-ZA | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PH

Update requires: Replacement

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

VocabularyName

A unique name of the custom vocabulary.

Required: Yes

Type: String

Pattern: ^[0-9a-zA-Z._-]+$

Minimum: 1

Maximum: 140

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the custom vocabulary.

LastModifiedTime

The timestamp when the custom vocabulary was last modified.

State

The current state of the custom vocabulary.

VocabularyId

The identifier of the custom vocabulary.