AWS.Transcribe reference
CreateCallAnalyticsCategory
Section titled “CreateCallAnalyticsCategory”Source:
src/AWS/Transcribe/CreateCallAnalyticsCategory.ts
Runtime binding for transcribe:CreateCallAnalyticsCategory — create a Call Analytics category whose rules automatically flag matching calls (e.g. long silence, specific phrases, negative sentiment).
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:CreateCallAnalyticsCategory on *.
CreateCallAnalyticsCategory: Call Analytics Categories
Section titled “CreateCallAnalyticsCategory: Call Analytics Categories”// initconst createCallAnalyticsCategory = yield* AWS.Transcribe.CreateCallAnalyticsCategory();
// runtimeyield* createCallAnalyticsCategory({ CategoryName: "long-silence", Rules: [{ NonTalkTimeFilter: { Threshold: 30000 } }],});CreateLanguageModel
Section titled “CreateLanguageModel”Source:
src/AWS/Transcribe/CreateLanguageModel.ts
Runtime binding for transcribe:CreateLanguageModel — kick off training of
a custom language model from text data in S3 (training runs asynchronously
and can take multiple hours; poll with DescribeLanguageModel).
The binding is constructed with the data-access role (the IAM role
Amazon Transcribe assumes to read your S3 training data; its trust policy
must allow transcribe.amazonaws.com). The role’s ARN is injected as
InputDataConfig.DataAccessRoleArn on every runtime request and the host
is granted iam:PassRole on it alongside transcribe:CreateLanguageModel
(which has no resource-level IAM).
CreateLanguageModel: Custom Language Models
Section titled “CreateLanguageModel: Custom Language Models”// init — bind the Transcribe data-access roleconst createLanguageModel = yield* AWS.Transcribe.CreateLanguageModel(dataAccessRole);
// runtimeyield* createLanguageModel({ ModelName: "my-domain-model", BaseModelName: "NarrowBand", LanguageCode: "en-US", InputDataConfig: { S3Uri: "s3://my-bucket/training-data/" },});CreateMedicalVocabulary
Section titled “CreateMedicalVocabulary”Source:
src/AWS/Transcribe/CreateMedicalVocabulary.ts
Runtime binding for transcribe:CreateMedicalVocabulary — create a custom medical vocabulary from a text file in S3 (asynchronous: created PENDING, poll to READY with GetMedicalVocabulary).
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:CreateMedicalVocabulary on *.
CreateMedicalVocabulary: Medical Vocabularies
Section titled “CreateMedicalVocabulary: Medical Vocabularies”// initconst createMedicalVocabulary = yield* AWS.Transcribe.CreateMedicalVocabulary();
// runtimeyield* createMedicalVocabulary({ VocabularyName: "clinic-vocabulary", LanguageCode: "en-US", VocabularyFileUri: "s3://my-bucket/vocab.txt",});CreateVocabulary
Section titled “CreateVocabulary”Source:
src/AWS/Transcribe/CreateVocabulary.ts
Runtime binding for transcribe:CreateVocabulary — create a custom vocabulary that improves transcription accuracy for domain-specific terms (e.g. per-tenant vocabularies created at runtime).
Vocabulary processing is asynchronous: the vocabulary is created in the PENDING state and must reach READY (poll with GetVocabulary) before a transcription job can reference it.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:CreateVocabulary on *.
CreateVocabulary: Custom Vocabularies
Section titled “CreateVocabulary: Custom Vocabularies”// initconst createVocabulary = yield* AWS.Transcribe.CreateVocabulary();
// runtimeconst { VocabularyState } = yield* createVocabulary({ VocabularyName: "tenant-123-vocabulary", LanguageCode: "en-US", Phrases: ["Alchemy", "workerd"],});CreateVocabularyFilter
Section titled “CreateVocabularyFilter”Source:
src/AWS/Transcribe/CreateVocabularyFilter.ts
Runtime binding for transcribe:CreateVocabularyFilter — create a vocabulary filter that masks, removes, or flags unwanted words in transcription output.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:CreateVocabularyFilter on *.
CreateVocabularyFilter: Vocabulary Filters
Section titled “CreateVocabularyFilter: Vocabulary Filters”// initconst createVocabularyFilter = yield* AWS.Transcribe.CreateVocabularyFilter();
// runtimeyield* createVocabularyFilter({ VocabularyFilterName: "profanity-filter", LanguageCode: "en-US", Words: ["unwanted", "words"],});DeleteCallAnalyticsCategory
Section titled “DeleteCallAnalyticsCategory”Source:
src/AWS/Transcribe/DeleteCallAnalyticsCategory.ts
Runtime binding for transcribe:DeleteCallAnalyticsCategory — delete a Call Analytics category.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteCallAnalyticsCategory on *.
DeleteCallAnalyticsCategory: Call Analytics Categories
Section titled “DeleteCallAnalyticsCategory: Call Analytics Categories”// initconst deleteCallAnalyticsCategory = yield* AWS.Transcribe.DeleteCallAnalyticsCategory();
// runtimeyield* deleteCallAnalyticsCategory({ CategoryName: "long-silence" });DeleteCallAnalyticsJob
Section titled “DeleteCallAnalyticsJob”Source:
src/AWS/Transcribe/DeleteCallAnalyticsJob.ts
Runtime binding for transcribe:DeleteCallAnalyticsJob — delete a Call Analytics job.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteCallAnalyticsJob on *.
DeleteCallAnalyticsJob: Call Analytics Jobs
Section titled “DeleteCallAnalyticsJob: Call Analytics Jobs”// initconst deleteCallAnalyticsJob = yield* AWS.Transcribe.DeleteCallAnalyticsJob();
// runtimeyield* deleteCallAnalyticsJob({ CallAnalyticsJobName: "my-call" });DeleteLanguageModel
Section titled “DeleteLanguageModel”Source:
src/AWS/Transcribe/DeleteLanguageModel.ts
Runtime binding for transcribe:DeleteLanguageModel — delete a custom language model.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteLanguageModel on *.
DeleteLanguageModel: Custom Language Models
Section titled “DeleteLanguageModel: Custom Language Models”// initconst deleteLanguageModel = yield* AWS.Transcribe.DeleteLanguageModel();
// runtimeyield* deleteLanguageModel({ ModelName: "my-domain-model" });DeleteMedicalScribeJob
Section titled “DeleteMedicalScribeJob”Source:
src/AWS/Transcribe/DeleteMedicalScribeJob.ts
Runtime binding for transcribe:DeleteMedicalScribeJob — delete a Medical Scribe job.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteMedicalScribeJob on *.
DeleteMedicalScribeJob: Medical Scribe Jobs
Section titled “DeleteMedicalScribeJob: Medical Scribe Jobs”// initconst deleteMedicalScribeJob = yield* AWS.Transcribe.DeleteMedicalScribeJob();
// runtimeyield* deleteMedicalScribeJob({ MedicalScribeJobName: "my-visit" });DeleteMedicalTranscriptionJob
Section titled “DeleteMedicalTranscriptionJob”Source:
src/AWS/Transcribe/DeleteMedicalTranscriptionJob.ts
Runtime binding for transcribe:DeleteMedicalTranscriptionJob — delete a medical transcription job.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteMedicalTranscriptionJob on *.
DeleteMedicalTranscriptionJob: Medical Transcription Jobs
Section titled “DeleteMedicalTranscriptionJob: Medical Transcription Jobs”// initconst deleteMedicalTranscriptionJob = yield* AWS.Transcribe.DeleteMedicalTranscriptionJob();
// runtimeyield* deleteMedicalTranscriptionJob({ MedicalTranscriptionJobName: "my-medical-job" });DeleteMedicalVocabulary
Section titled “DeleteMedicalVocabulary”Source:
src/AWS/Transcribe/DeleteMedicalVocabulary.ts
Runtime binding for transcribe:DeleteMedicalVocabulary — delete a medical vocabulary.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteMedicalVocabulary on *.
DeleteMedicalVocabulary: Medical Vocabularies
Section titled “DeleteMedicalVocabulary: Medical Vocabularies”// initconst deleteMedicalVocabulary = yield* AWS.Transcribe.DeleteMedicalVocabulary();
// runtimeyield* deleteMedicalVocabulary({ VocabularyName: "clinic-vocabulary" });DeleteTranscriptionJob
Section titled “DeleteTranscriptionJob”Source:
src/AWS/Transcribe/DeleteTranscriptionJob.ts
Runtime binding for transcribe:DeleteTranscriptionJob — delete a batch transcription job and its transcript from the service-managed output location.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteTranscriptionJob on *.
DeleteTranscriptionJob: Batch Transcription Jobs
Section titled “DeleteTranscriptionJob: Batch Transcription Jobs”// initconst deleteTranscriptionJob = yield* AWS.Transcribe.DeleteTranscriptionJob();
// runtimeyield* deleteTranscriptionJob({ TranscriptionJobName: "my-job" });DeleteVocabulary
Section titled “DeleteVocabulary”Source:
src/AWS/Transcribe/DeleteVocabulary.ts
Runtime binding for transcribe:DeleteVocabulary — delete a custom vocabulary.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteVocabulary on *.
DeleteVocabulary: Custom Vocabularies
Section titled “DeleteVocabulary: Custom Vocabularies”// initconst deleteVocabulary = yield* AWS.Transcribe.DeleteVocabulary();
// runtimeyield* deleteVocabulary({ VocabularyName: "tenant-123-vocabulary" });DeleteVocabularyFilter
Section titled “DeleteVocabularyFilter”Source:
src/AWS/Transcribe/DeleteVocabularyFilter.ts
Runtime binding for transcribe:DeleteVocabularyFilter — delete a vocabulary filter.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DeleteVocabularyFilter on *.
DeleteVocabularyFilter: Vocabulary Filters
Section titled “DeleteVocabularyFilter: Vocabulary Filters”// initconst deleteVocabularyFilter = yield* AWS.Transcribe.DeleteVocabularyFilter();
// runtimeyield* deleteVocabularyFilter({ VocabularyFilterName: "profanity-filter" });DescribeLanguageModel
Section titled “DescribeLanguageModel”Source:
src/AWS/Transcribe/DescribeLanguageModel.ts
Runtime binding for transcribe:DescribeLanguageModel — read a custom language model’s training status and metadata.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:DescribeLanguageModel on *.
DescribeLanguageModel: Custom Language Models
Section titled “DescribeLanguageModel: Custom Language Models”// initconst describeLanguageModel = yield* AWS.Transcribe.DescribeLanguageModel();
// runtimeconst { LanguageModel } = yield* describeLanguageModel({ ModelName: "my-domain-model",});GetCallAnalyticsCategory
Section titled “GetCallAnalyticsCategory”Source:
src/AWS/Transcribe/GetCallAnalyticsCategory.ts
Runtime binding for transcribe:GetCallAnalyticsCategory — read a Call Analytics category’s rules.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetCallAnalyticsCategory on *.
GetCallAnalyticsCategory: Call Analytics Categories
Section titled “GetCallAnalyticsCategory: Call Analytics Categories”// initconst getCallAnalyticsCategory = yield* AWS.Transcribe.GetCallAnalyticsCategory();
// runtimeconst { CategoryProperties } = yield* getCallAnalyticsCategory({ CategoryName: "long-silence",});GetCallAnalyticsJob
Section titled “GetCallAnalyticsJob”Source:
src/AWS/Transcribe/GetCallAnalyticsJob.ts
Runtime binding for transcribe:GetCallAnalyticsJob — read a Call Analytics job’s status and, once complete, the transcript location.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetCallAnalyticsJob on *.
GetCallAnalyticsJob: Call Analytics Jobs
Section titled “GetCallAnalyticsJob: Call Analytics Jobs”// initconst getCallAnalyticsJob = yield* AWS.Transcribe.GetCallAnalyticsJob();
// runtimeconst { CallAnalyticsJob } = yield* getCallAnalyticsJob({ CallAnalyticsJobName: "my-call",});GetMedicalScribeJob
Section titled “GetMedicalScribeJob”Source:
src/AWS/Transcribe/GetMedicalScribeJob.ts
Runtime binding for transcribe:GetMedicalScribeJob — read a Medical Scribe job’s status and, once complete, the clinical note and transcript locations.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetMedicalScribeJob on *.
GetMedicalScribeJob: Medical Scribe Jobs
Section titled “GetMedicalScribeJob: Medical Scribe Jobs”// initconst getMedicalScribeJob = yield* AWS.Transcribe.GetMedicalScribeJob();
// runtimeconst { MedicalScribeJob } = yield* getMedicalScribeJob({ MedicalScribeJobName: "my-visit",});GetMedicalTranscriptionJob
Section titled “GetMedicalTranscriptionJob”Source:
src/AWS/Transcribe/GetMedicalTranscriptionJob.ts
Runtime binding for transcribe:GetMedicalTranscriptionJob — read a medical transcription job’s status and transcript location.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetMedicalTranscriptionJob on *.
GetMedicalTranscriptionJob: Medical Transcription Jobs
Section titled “GetMedicalTranscriptionJob: Medical Transcription Jobs”// initconst getMedicalTranscriptionJob = yield* AWS.Transcribe.GetMedicalTranscriptionJob();
// runtimeconst { MedicalTranscriptionJob } = yield* getMedicalTranscriptionJob({ MedicalTranscriptionJobName: "my-medical-job",});GetMedicalVocabulary
Section titled “GetMedicalVocabulary”Source:
src/AWS/Transcribe/GetMedicalVocabulary.ts
Runtime binding for transcribe:GetMedicalVocabulary — read a medical vocabulary’s processing state and download URI.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetMedicalVocabulary on *.
GetMedicalVocabulary: Medical Vocabularies
Section titled “GetMedicalVocabulary: Medical Vocabularies”// initconst getMedicalVocabulary = yield* AWS.Transcribe.GetMedicalVocabulary();
// runtimeconst { VocabularyState } = yield* getMedicalVocabulary({ VocabularyName: "clinic-vocabulary",});GetTranscriptionJob
Section titled “GetTranscriptionJob”Source:
src/AWS/Transcribe/GetTranscriptionJob.ts
Runtime binding for transcribe:GetTranscriptionJob — read the status and
result of a batch transcription job started with
StartTranscriptionJob.
Account-scoped (no resource to manage): the binding takes no arguments and
grants the function transcribe:GetTranscriptionJob (the action has no
resource-level IAM). Poll TranscriptionJob.TranscriptionJobStatus until
it reaches COMPLETED or FAILED.
GetTranscriptionJob: Polling a Transcription Job
Section titled “GetTranscriptionJob: Polling a Transcription Job”// initconst getJob = yield* AWS.Transcribe.GetTranscriptionJob();
// runtimeconst { TranscriptionJob } = yield* getJob({ TranscriptionJobName: "my-job",});const status = TranscriptionJob?.TranscriptionJobStatus;GetVocabulary
Section titled “GetVocabulary”Source:
src/AWS/Transcribe/GetVocabulary.ts
Runtime binding for transcribe:GetVocabulary — read a custom vocabulary’s processing state and download URI.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetVocabulary on *.
GetVocabulary: Custom Vocabularies
Section titled “GetVocabulary: Custom Vocabularies”// initconst getVocabulary = yield* AWS.Transcribe.GetVocabulary();
// runtimeconst { VocabularyState } = yield* getVocabulary({ VocabularyName: "tenant-123-vocabulary",});GetVocabularyFilter
Section titled “GetVocabularyFilter”Source:
src/AWS/Transcribe/GetVocabularyFilter.ts
Runtime binding for transcribe:GetVocabularyFilter — read a vocabulary filter’s metadata and download URI.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:GetVocabularyFilter on *.
GetVocabularyFilter: Vocabulary Filters
Section titled “GetVocabularyFilter: Vocabulary Filters”// initconst getVocabularyFilter = yield* AWS.Transcribe.GetVocabularyFilter();
// runtimeconst { DownloadUri } = yield* getVocabularyFilter({ VocabularyFilterName: "profanity-filter",});ListCallAnalyticsCategories
Section titled “ListCallAnalyticsCategories”Source:
src/AWS/Transcribe/ListCallAnalyticsCategories.ts
Runtime binding for transcribe:ListCallAnalyticsCategories — list the Call Analytics categories in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListCallAnalyticsCategories on *.
ListCallAnalyticsCategories: Call Analytics Categories
Section titled “ListCallAnalyticsCategories: Call Analytics Categories”// initconst listCallAnalyticsCategories = yield* AWS.Transcribe.ListCallAnalyticsCategories();
// runtimeconst { Categories } = yield* listCallAnalyticsCategories({ MaxResults: 10 });ListCallAnalyticsJobs
Section titled “ListCallAnalyticsJobs”Source:
src/AWS/Transcribe/ListCallAnalyticsJobs.ts
Runtime binding for transcribe:ListCallAnalyticsJobs — list the Call Analytics jobs in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListCallAnalyticsJobs on *.
ListCallAnalyticsJobs: Call Analytics Jobs
Section titled “ListCallAnalyticsJobs: Call Analytics Jobs”// initconst listCallAnalyticsJobs = yield* AWS.Transcribe.ListCallAnalyticsJobs();
// runtimeconst { CallAnalyticsJobSummaries } = yield* listCallAnalyticsJobs({ MaxResults: 10 });ListLanguageModels
Section titled “ListLanguageModels”Source:
src/AWS/Transcribe/ListLanguageModels.ts
Runtime binding for transcribe:ListLanguageModels — list the custom language models in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListLanguageModels on *.
ListLanguageModels: Custom Language Models
Section titled “ListLanguageModels: Custom Language Models”// initconst listLanguageModels = yield* AWS.Transcribe.ListLanguageModels();
// runtimeconst { Models } = yield* listLanguageModels({ MaxResults: 10 });ListMedicalScribeJobs
Section titled “ListMedicalScribeJobs”Source:
src/AWS/Transcribe/ListMedicalScribeJobs.ts
Runtime binding for transcribe:ListMedicalScribeJobs — list the Medical Scribe jobs in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListMedicalScribeJobs on *.
ListMedicalScribeJobs: Medical Scribe Jobs
Section titled “ListMedicalScribeJobs: Medical Scribe Jobs”// initconst listMedicalScribeJobs = yield* AWS.Transcribe.ListMedicalScribeJobs();
// runtimeconst { MedicalScribeJobSummaries } = yield* listMedicalScribeJobs({ MaxResults: 10 });ListMedicalTranscriptionJobs
Section titled “ListMedicalTranscriptionJobs”Source:
src/AWS/Transcribe/ListMedicalTranscriptionJobs.ts
Runtime binding for transcribe:ListMedicalTranscriptionJobs — list the medical transcription jobs in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListMedicalTranscriptionJobs on *.
ListMedicalTranscriptionJobs: Medical Transcription Jobs
Section titled “ListMedicalTranscriptionJobs: Medical Transcription Jobs”// initconst listMedicalTranscriptionJobs = yield* AWS.Transcribe.ListMedicalTranscriptionJobs();
// runtimeconst { MedicalTranscriptionJobSummaries } = yield* listMedicalTranscriptionJobs({ MaxResults: 10 });ListMedicalVocabularies
Section titled “ListMedicalVocabularies”Source:
src/AWS/Transcribe/ListMedicalVocabularies.ts
Runtime binding for transcribe:ListMedicalVocabularies — list the medical vocabularies in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListMedicalVocabularies on *.
ListMedicalVocabularies: Medical Vocabularies
Section titled “ListMedicalVocabularies: Medical Vocabularies”// initconst listMedicalVocabularies = yield* AWS.Transcribe.ListMedicalVocabularies();
// runtimeconst { Vocabularies } = yield* listMedicalVocabularies({ MaxResults: 10 });ListTagsForResource
Section titled “ListTagsForResource”Source:
src/AWS/Transcribe/ListTagsForResource.ts
Runtime binding for transcribe:ListTagsForResource — list the tags on a Transcribe resource by ARN.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListTagsForResource on *.
ListTagsForResource: Tagging
Section titled “ListTagsForResource: Tagging”// initconst listTagsForResource = yield* AWS.Transcribe.ListTagsForResource();
// runtimeconst { Tags } = yield* listTagsForResource({ ResourceArn: "arn:aws:transcribe:us-east-1:123456789012:vocabulary/tenant-123",});ListTranscriptionJobs
Section titled “ListTranscriptionJobs”Source:
src/AWS/Transcribe/ListTranscriptionJobs.ts
Runtime binding for transcribe:ListTranscriptionJobs — list the batch transcription jobs in the account, optionally filtered by status or name prefix.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListTranscriptionJobs on *.
ListTranscriptionJobs: Batch Transcription Jobs
Section titled “ListTranscriptionJobs: Batch Transcription Jobs”// initconst listTranscriptionJobs = yield* AWS.Transcribe.ListTranscriptionJobs();
// runtimeconst { TranscriptionJobSummaries } = yield* listTranscriptionJobs({ Status: "COMPLETED", MaxResults: 10,});ListVocabularies
Section titled “ListVocabularies”Source:
src/AWS/Transcribe/ListVocabularies.ts
Runtime binding for transcribe:ListVocabularies — list the custom vocabularies in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListVocabularies on *.
ListVocabularies: Custom Vocabularies
Section titled “ListVocabularies: Custom Vocabularies”// initconst listVocabularies = yield* AWS.Transcribe.ListVocabularies();
// runtimeconst { Vocabularies } = yield* listVocabularies({ MaxResults: 10 });ListVocabularyFilters
Section titled “ListVocabularyFilters”Source:
src/AWS/Transcribe/ListVocabularyFilters.ts
Runtime binding for transcribe:ListVocabularyFilters — list the vocabulary filters in the account.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:ListVocabularyFilters on *.
ListVocabularyFilters: Vocabulary Filters
Section titled “ListVocabularyFilters: Vocabulary Filters”// initconst listVocabularyFilters = yield* AWS.Transcribe.ListVocabularyFilters();
// runtimeconst { VocabularyFilters } = yield* listVocabularyFilters({ MaxResults: 10 });StartCallAnalyticsJob
Section titled “StartCallAnalyticsJob”Source:
src/AWS/Transcribe/StartCallAnalyticsJob.ts
Runtime binding for transcribe:StartCallAnalyticsJob — start an asynchronous Call Analytics job (transcription plus call characteristics, sentiment, and category matching) over a call recording in S3.
The binding is constructed with the data-access role (the IAM role
Amazon Transcribe assumes to read your Amazon S3 data and write results;
its trust policy must allow transcribe.amazonaws.com). The role’s ARN
is injected as DataAccessRoleArn on every runtime request and the host
is granted iam:PassRole on it alongside transcribe:StartCallAnalyticsJob
(which has no resource-level IAM).
StartCallAnalyticsJob: Call Analytics Jobs
Section titled “StartCallAnalyticsJob: Call Analytics Jobs”// init — bind the Transcribe data-access roleconst startCallAnalyticsJob = yield* AWS.Transcribe.StartCallAnalyticsJob(dataAccessRole);
// runtimeconst { CallAnalyticsJob } = yield* startCallAnalyticsJob({ CallAnalyticsJobName: "my-call", Media: { MediaFileUri: "s3://my-bucket/calls/call.wav" },});StartMedicalScribeJob
Section titled “StartMedicalScribeJob”Source:
src/AWS/Transcribe/StartMedicalScribeJob.ts
Runtime binding for transcribe:StartMedicalScribeJob — start an AWS HealthScribe job that transcribes a patient-clinician conversation and generates preliminary clinical notes.
The binding is constructed with the data-access role (the IAM role
Amazon Transcribe assumes to read your Amazon S3 data and write results;
its trust policy must allow transcribe.amazonaws.com). The role’s ARN
is injected as DataAccessRoleArn on every runtime request and the host
is granted iam:PassRole on it alongside transcribe:StartMedicalScribeJob
(which has no resource-level IAM).
StartMedicalScribeJob: Medical Scribe Jobs
Section titled “StartMedicalScribeJob: Medical Scribe Jobs”// init — bind the Transcribe data-access roleconst startMedicalScribeJob = yield* AWS.Transcribe.StartMedicalScribeJob(dataAccessRole);
// runtimeconst { MedicalScribeJob } = yield* startMedicalScribeJob({ MedicalScribeJobName: "my-visit", Media: { MediaFileUri: "s3://my-bucket/visits/visit.wav" }, OutputBucketName: "my-output-bucket", Settings: { ShowSpeakerLabels: true, MaxSpeakerLabels: 2 },});StartMedicalTranscriptionJob
Section titled “StartMedicalTranscriptionJob”Source:
src/AWS/Transcribe/StartMedicalTranscriptionJob.ts
Runtime binding for transcribe:StartMedicalTranscriptionJob — start an asynchronous medical transcription job over an audio file in S3 (output goes to your bucket).
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:StartMedicalTranscriptionJob on *.
StartMedicalTranscriptionJob: Medical Transcription Jobs
Section titled “StartMedicalTranscriptionJob: Medical Transcription Jobs”// initconst startMedicalTranscriptionJob = yield* AWS.Transcribe.StartMedicalTranscriptionJob();
// runtimeconst { MedicalTranscriptionJob } = yield* startMedicalTranscriptionJob({ MedicalTranscriptionJobName: "my-medical-job", LanguageCode: "en-US", Media: { MediaFileUri: "s3://my-bucket/dictation.wav" }, OutputBucketName: "my-output-bucket", Specialty: "PRIMARYCARE", Type: "DICTATION",});StartTranscriptionJob
Section titled “StartTranscriptionJob”Source:
src/AWS/Transcribe/StartTranscriptionJob.ts
Runtime binding for transcribe:StartTranscriptionJob — kick off an
asynchronous batch transcription of an audio/video file stored in S3.
Transcribe batch jobs are account-scoped (no resource to manage): the
binding takes no arguments and grants the function
transcribe:StartTranscriptionJob (the action has no resource-level IAM).
The input Media.MediaFileUri and the output bucket are S3 locations —
grant the function S3 access to those buckets separately. Poll the job to
completion with GetTranscriptionJob.
StartTranscriptionJob: Starting a Transcription Job
Section titled “StartTranscriptionJob: Starting a Transcription Job”// initconst startJob = yield* AWS.Transcribe.StartTranscriptionJob();
// runtimeconst { TranscriptionJob } = yield* startJob({ TranscriptionJobName: "my-job", LanguageCode: "en-US", Media: { MediaFileUri: "s3://my-bucket/audio/sample.wav" }, OutputBucketName: "my-output-bucket",});TagResource
Section titled “TagResource”Source:
src/AWS/Transcribe/TagResource.ts
Runtime binding for transcribe:TagResource — add tags to a Transcribe resource (jobs, vocabularies, filters, categories, or models) by ARN.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:TagResource on *.
TagResource: Tagging
Section titled “TagResource: Tagging”// initconst tagResource = yield* AWS.Transcribe.TagResource();
// runtimeyield* tagResource({ ResourceArn: "arn:aws:transcribe:us-east-1:123456789012:vocabulary/tenant-123", Tags: [{ Key: "tenant", Value: "123" }],});UntagResource
Section titled “UntagResource”Source:
src/AWS/Transcribe/UntagResource.ts
Runtime binding for transcribe:UntagResource — remove tags from a Transcribe resource by ARN.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:UntagResource on *.
UntagResource: Tagging
Section titled “UntagResource: Tagging”// initconst untagResource = yield* AWS.Transcribe.UntagResource();
// runtimeyield* untagResource({ ResourceArn: "arn:aws:transcribe:us-east-1:123456789012:vocabulary/tenant-123", TagKeys: ["tenant"],});UpdateCallAnalyticsCategory
Section titled “UpdateCallAnalyticsCategory”Source:
src/AWS/Transcribe/UpdateCallAnalyticsCategory.ts
Runtime binding for transcribe:UpdateCallAnalyticsCategory — replace a Call Analytics category’s rules.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:UpdateCallAnalyticsCategory on *.
UpdateCallAnalyticsCategory: Call Analytics Categories
Section titled “UpdateCallAnalyticsCategory: Call Analytics Categories”// initconst updateCallAnalyticsCategory = yield* AWS.Transcribe.UpdateCallAnalyticsCategory();
// runtimeyield* updateCallAnalyticsCategory({ CategoryName: "long-silence", Rules: [{ NonTalkTimeFilter: { Threshold: 60000 } }],});UpdateMedicalVocabulary
Section titled “UpdateMedicalVocabulary”Source:
src/AWS/Transcribe/UpdateMedicalVocabulary.ts
Runtime binding for transcribe:UpdateMedicalVocabulary — replace a medical vocabulary with a new source file.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:UpdateMedicalVocabulary on *.
UpdateMedicalVocabulary: Medical Vocabularies
Section titled “UpdateMedicalVocabulary: Medical Vocabularies”// initconst updateMedicalVocabulary = yield* AWS.Transcribe.UpdateMedicalVocabulary();
// runtimeyield* updateMedicalVocabulary({ VocabularyName: "clinic-vocabulary", LanguageCode: "en-US", VocabularyFileUri: "s3://my-bucket/vocab-v2.txt",});UpdateVocabulary
Section titled “UpdateVocabulary”Source:
src/AWS/Transcribe/UpdateVocabulary.ts
Runtime binding for transcribe:UpdateVocabulary — replace a custom vocabulary’s phrases (the vocabulary re-enters PENDING while it reprocesses).
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:UpdateVocabulary on *.
UpdateVocabulary: Custom Vocabularies
Section titled “UpdateVocabulary: Custom Vocabularies”// initconst updateVocabulary = yield* AWS.Transcribe.UpdateVocabulary();
// runtimeyield* updateVocabulary({ VocabularyName: "tenant-123-vocabulary", LanguageCode: "en-US", Phrases: ["Alchemy", "workerd", "distilled"],});UpdateVocabularyFilter
Section titled “UpdateVocabularyFilter”Source:
src/AWS/Transcribe/UpdateVocabularyFilter.ts
Runtime binding for transcribe:UpdateVocabularyFilter — replace a vocabulary filter’s word list.
Amazon Transcribe batch actions have no resource-level IAM; the host is
granted transcribe:UpdateVocabularyFilter on *.
UpdateVocabularyFilter: Vocabulary Filters
Section titled “UpdateVocabularyFilter: Vocabulary Filters”// initconst updateVocabularyFilter = yield* AWS.Transcribe.UpdateVocabularyFilter();
// runtimeyield* updateVocabularyFilter({ VocabularyFilterName: "profanity-filter", Words: ["unwanted", "words", "more"],});