We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
Creates a custom vocabulary that you can use to improve the transcription accuracy of domain-specific words and phrases.
Create Vocabulary Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Vocabulary(name: string, args: VocabularyArgs, opts?: CustomResourceOptions);@overload
def Vocabulary(resource_name: str,
args: VocabularyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Vocabulary(resource_name: str,
opts: Optional[ResourceOptions] = None,
language_code: Optional[str] = None,
data_access_role_arn: Optional[str] = None,
phrases: Optional[Sequence[str]] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
vocabulary_file_uri: Optional[str] = None,
vocabulary_name: Optional[str] = None)func NewVocabulary(ctx *Context, name string, args VocabularyArgs, opts ...ResourceOption) (*Vocabulary, error)public Vocabulary(string name, VocabularyArgs args, CustomResourceOptions? opts = null)
public Vocabulary(String name, VocabularyArgs args)
public Vocabulary(String name, VocabularyArgs args, CustomResourceOptions options)
type: aws-native:transcribe:Vocabulary
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_transcribe_vocabulary" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args VocabularyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args VocabularyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args VocabularyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VocabularyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VocabularyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Vocabulary Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Vocabulary resource accepts the following input properties:
- Language
Code string - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- Data
Access stringRole Arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- Phrases List<string>
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
-
List<Pulumi.
Aws Native. Inputs. Tag> - Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- Vocabulary
File stringUri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- Vocabulary
Name string - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
- Language
Code string - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- Data
Access stringRole Arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- Phrases []string
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
-
Tag
Args - Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- Vocabulary
File stringUri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- Vocabulary
Name string - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
- language_
code string - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- data_
access_ stringrole_ arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- phrases list(string)
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
- list(object)
- Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- vocabulary_
file_ stringuri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- vocabulary_
name string - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
- language
Code String - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- data
Access StringRole Arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- phrases List<String>
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
- List<Tag>
- Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- vocabulary
File StringUri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- vocabulary
Name String - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
- language
Code string - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- data
Access stringRole Arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- phrases string[]
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
- Tag[]
- Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- vocabulary
File stringUri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- vocabulary
Name string - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
- language_
code str - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- data_
access_ strrole_ arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- phrases Sequence[str]
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
-
Sequence[Tag
Args] - Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- vocabulary_
file_ struri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- vocabulary_
name str - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
- language
Code String - The language code that represents the language of the entries in your custom vocabulary. Each custom vocabulary must contain terms in only one language.
- data
Access StringRole Arn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input file.
- phrases List<String>
- Use this parameter if you want to create your custom vocabulary by including all desired terms, as comma-separated values, within your request. You cannot use this parameter together with VocabularyFileUri.
- List<Property Map>
- Adds one or more custom tags, each in the form of a key:value pair, to the custom vocabulary.
- vocabulary
File StringUri - The Amazon S3 location of the text file that contains your custom vocabulary. You cannot use this parameter together with Phrases.
- vocabulary
Name String - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an AWS account.
Outputs
All input properties are implicitly available as output properties. Additionally, the Vocabulary resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the custom vocabulary.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The date and time the specified custom vocabulary was last modified.
- Vocabulary
State Pulumi.Aws Native. Transcribe. Vocabulary State - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
- Arn string
- The Amazon Resource Name (ARN) of the custom vocabulary.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The date and time the specified custom vocabulary was last modified.
- Vocabulary
State VocabularyState Enum - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
- arn string
- The Amazon Resource Name (ARN) of the custom vocabulary.
- id string
- The provider-assigned unique ID for this managed resource.
- last_
modified_ stringtime - The date and time the specified custom vocabulary was last modified.
- vocabulary_
state "PENDING" | "READY" | "FAILED" - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
- arn String
- The Amazon Resource Name (ARN) of the custom vocabulary.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The date and time the specified custom vocabulary was last modified.
- vocabulary
State VocabularyState - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
- arn string
- The Amazon Resource Name (ARN) of the custom vocabulary.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTime - The date and time the specified custom vocabulary was last modified.
- vocabulary
State VocabularyState - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
- arn str
- The Amazon Resource Name (ARN) of the custom vocabulary.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime - The date and time the specified custom vocabulary was last modified.
- vocabulary_
state VocabularyState - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
- arn String
- The Amazon Resource Name (ARN) of the custom vocabulary.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The date and time the specified custom vocabulary was last modified.
- vocabulary
State "PENDING" | "READY" | "FAILED" - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.
Supporting Types
Tag, TagArgs
A set of tags to apply to the resource.VocabularyState, VocabularyStateArgs
- Pending
PENDING- Ready
READY- Failed
FAILED
- Vocabulary
State Pending PENDING- Vocabulary
State Ready READY- Vocabulary
State Failed FAILED
- "PENDING"
PENDING- "READY"
READY- "FAILED"
FAILED
- Pending
PENDING- Ready
READY- Failed
FAILED
- Pending
PENDING- Ready
READY- Failed
FAILED
- PENDING
PENDING- READY
READY- FAILED
FAILED
- "PENDING"
PENDING- "READY"
READY- "FAILED"
FAILED
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi