There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Use `StartTranscriptionJob` with an AWS SDK or CLI
The following code examples show how to use `StartTranscriptionJob`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Create and refine a custom vocabulary](transcribe_example_transcribe_Scenario_CustomVocabulary_section.md)
+ [Transcribe audio and get job data](transcribe_example_transcribe_Scenario_GettingStartedTranscriptionJobs_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Transcribe#code-examples).
```
///
/// Start a transcription job for a media file. This method returns
/// as soon as the job is started.
///
/// A unique name for the transcription job.
/// The URI of the media file, typically an Amazon S3 location.
/// The format of the media file.
/// The language code of the media file, such as en-US.
/// Optional name of a custom vocabulary.
/// A TranscriptionJob instance with information on the new job.
public async Task StartTranscriptionJob(string jobName, string mediaFileUri,
MediaFormat mediaFormat, LanguageCode languageCode, string? vocabularyName)
{
var response = await _amazonTranscribeService.StartTranscriptionJobAsync(
new StartTranscriptionJobRequest()
{
TranscriptionJobName = jobName,
Media = new Media()
{
MediaFileUri = mediaFileUri
},
MediaFormat = mediaFormat,
LanguageCode = languageCode,
Settings = vocabularyName != null ? new Settings()
{
VocabularyName = vocabularyName
} : null
});
return response.TranscriptionJob;
}
```
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/goto/DotNetSDKV3/transcribe-2017-10-26/StartTranscriptionJob) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**Example 1: To transcribe an audio file**
The following `start-transcription-job` example transcribes your audio file.
```
aws transcribe start-transcription-job \
--cli-input-json file://myfile.json
```
Contents of `myfile.json`:
```
{
"TranscriptionJobName": "cli-simple-transcription-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
}
}
```
For more information, see [Getting Started (AWS Command Line Interface)](https://docs.aws.amazon.com/transcribe/latest/dg/getting-started-cli.html) in the *Amazon Transcribe Developer Guide*.
**Example 2: To transcribe a multi-channel audio file**
The following `start-transcription-job` example transcribes your multi-channel audio file.
```
aws transcribe start-transcription-job \
--cli-input-json file://mysecondfile.json
```
Contents of `mysecondfile.json`:
```
{
"TranscriptionJobName": "cli-channelid-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"ChannelIdentification":true
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-channelid-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-17T16:07:56.817000+00:00",
"CreationTime": "2020-09-17T16:07:56.784000+00:00",
"Settings": {
"ChannelIdentification": true
}
}
}
```
For more information, see [Transcribing Multi-Channel Audio](https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html) in the *Amazon Transcribe Developer Guide*.
**Example 3: To transcribe an audio file and identify the different speakers**
The following `start-transcription-job` example transcribes your audio file and identifies the speakers in the transcription output.
```
aws transcribe start-transcription-job \
--cli-input-json file://mythirdfile.json
```
Contents of `mythirdfile.json`:
```
{
"TranscriptionJobName": "cli-speakerid-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"ShowSpeakerLabels": true,
"MaxSpeakerLabels": 2
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-speakerid-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-17T16:22:59.696000+00:00",
"CreationTime": "2020-09-17T16:22:59.676000+00:00",
"Settings": {
"ShowSpeakerLabels": true,
"MaxSpeakerLabels": 2
}
}
}
```
For more information, see [Identifying Speakers](https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html) in the *Amazon Transcribe Developer Guide*.
**Example 4: To transcribe an audio file and mask any unwanted words in the transcription output**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://myfourthfile.json
```
Contents of `myfourthfile.json`:
```
{
"TranscriptionJobName": "cli-filter-mask-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "mask"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-filter-mask-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"StartTime": "2020-09-18T16:36:18.568000+00:00",
"CreationTime": "2020-09-18T16:36:18.547000+00:00",
"Settings": {
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "mask"
}
}
}
```
For more information, see [Filtering Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/filter-transcriptions.html) in the *Amazon Transcribe Developer Guide*.
**Example 5: To transcribe an audio file and remove any unwanted words in the transcription output**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://myfifthfile.json
```
Contents of `myfifthfile.json`:
```
{
"TranscriptionJobName": "cli-filter-remove-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "remove"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-filter-remove-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-18T16:36:18.568000+00:00",
"CreationTime": "2020-09-18T16:36:18.547000+00:00",
"Settings": {
"VocabularyFilterName": "your-vocabulary-filter",
"VocabularyFilterMethod": "remove"
}
}
}
```
For more information, see [Filtering Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/filter-transcriptions.html) in the *Amazon Transcribe Developer Guide*.
**Example 6: To transcribe an audio file with increased accuracy using a custom vocabulary**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://mysixthfile.json
```
Contents of `mysixthfile.json`:
```
{
"TranscriptionJobName": "cli-vocab-job",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"Settings":{
"VocabularyName": "your-vocabulary"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-vocab-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "the-language-of-your-transcription-job",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-18T16:36:18.568000+00:00",
"CreationTime": "2020-09-18T16:36:18.547000+00:00",
"Settings": {
"VocabularyName": "your-vocabulary"
}
}
}
```
For more information, see [Filtering Transcriptions](https://docs.aws.amazon.com/transcribe/latest/dg/filter-transcriptions.html) in the *Amazon Transcribe Developer Guide*.
**Example 7: To identify the language of an audio file and transcribe it**
The following `start-transcription-job` example transcribes your audio file and uses a vocabulary filter you've previously created to mask any unwanted words.
```
aws transcribe start-transcription-job \
--cli-input-json file://myseventhfile.json
```
Contents of `myseventhfile.json`:
```
{
"TranscriptionJobName": "cli-identify-language-transcription-job",
"IdentifyLanguage": true,
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-identify-language-transcription-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/Amazon-S3-prefix/your-media-file-name.file-extension"
},
"StartTime": "2020-09-18T22:27:23.970000+00:00",
"CreationTime": "2020-09-18T22:27:23.948000+00:00",
"IdentifyLanguage": true
}
}
```
For more information, see [Identifying the Language](https://docs.aws.amazon.com/transcribe/latest/dg/auto-lang-id.html) in the *Amazon Transcribe Developer Guide*.
**Example 8: To transcribe an audio file with personally identifiable information redacted**
The following `start-transcription-job` example transcribes your audio file and redacts any personally identifiable information in the transcription output.
```
aws transcribe start-transcription-job \
--cli-input-json file://myeighthfile.json
```
Contents of `myeigthfile.json`:
```
{
"TranscriptionJobName": "cli-redaction-job",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"ContentRedaction": {
"RedactionOutput":"redacted",
"RedactionType":"PII"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-redaction-job",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"StartTime": "2020-09-25T23:49:13.195000+00:00",
"CreationTime": "2020-09-25T23:49:13.176000+00:00",
"ContentRedaction": {
"RedactionType": "PII",
"RedactionOutput": "redacted"
}
}
}
```
For more information, see [Automatic Content Redaction](https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html) in the *Amazon Transcribe Developer Guide*.
**Example 9: To generate a transcript with personally identifiable information (PII) redacted and an unredacted transcript**
The following `start-transcription-job` example generates two transcrptions of your audio file, one with the personally identifiable information redacted, and the other without any redactions.
```
aws transcribe start-transcription-job \
--cli-input-json file://myninthfile.json
```
Contents of `myninthfile.json`:
```
{
"TranscriptionJobName": "cli-redaction-job-with-unredacted-transcript",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"ContentRedaction": {
"RedactionOutput":"redacted_and_unredacted",
"RedactionType":"PII"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-redaction-job-with-unredacted-transcript",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://Amazon-S3-Prefix/your-media-file.file-extension"
},
"StartTime": "2020-09-25T23:59:47.677000+00:00",
"CreationTime": "2020-09-25T23:59:47.653000+00:00",
"ContentRedaction": {
"RedactionType": "PII",
"RedactionOutput": "redacted_and_unredacted"
}
}
}
```
For more information, see [Automatic Content Redaction](https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html) in the *Amazon Transcribe Developer Guide*.
**Example 10: To use a custom language model you've previously created to transcribe an audio file.**
The following `start-transcription-job` example transcribes your audio file with a custom language model you've previously created.
```
aws transcribe start-transcription-job \
--cli-input-json file://mytenthfile.json
```
Contents of `mytenthfile.json`:
```
{
"TranscriptionJobName": "cli-clm-2-job-1",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.file-extension"
},
"ModelSettings": {
"LanguageModelName":"cli-clm-2"
}
}
```
Output:
```
{
"TranscriptionJob": {
"TranscriptionJobName": "cli-clm-2-job-1",
"TranscriptionJobStatus": "IN_PROGRESS",
"LanguageCode": "language-code",
"Media": {
"MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.file-extension"
},
"StartTime": "2020-09-28T17:56:01.835000+00:00",
"CreationTime": "2020-09-28T17:56:01.801000+00:00",
"ModelSettings": {
"LanguageModelName": "cli-clm-2"
}
}
}
```
For more information, see [Improving Domain-Specific Transcription Accuracy with Custom Language Models](https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html) in the *Amazon Transcribe Developer Guide*.
+ For API details, see [StartTranscriptionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/transcribe/start-transcription-job.html) in *AWS CLI Command Reference*.
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/transcribe#code-examples).
Start a transcription job.
```
// Import the required AWS SDK clients and commands for Node.js
import { StartTranscriptionJobCommand } from "@aws-sdk/client-transcribe";
import { transcribeClient } from "./libs/transcribeClient.js";
// Set the parameters
export const params = {
TranscriptionJobName: "JOB_NAME",
LanguageCode: "LANGUAGE_CODE", // For example, 'en-US'
MediaFormat: "SOURCE_FILE_FORMAT", // For example, 'wav'
Media: {
MediaFileUri: "SOURCE_LOCATION",
// For example, "https://transcribe-demo.s3-REGION.amazonaws.com/hello_world.wav"
},
OutputBucketName: "OUTPUT_BUCKET_NAME",
};
export const run = async () => {
try {
const data = await transcribeClient.send(
new StartTranscriptionJobCommand(params),
);
console.log("Success - put", data);
return data; // For unit tests.
} catch (err) {
console.log("Error", err);
}
};
run();
```
Create the client.
```
import { TranscribeClient } from "@aws-sdk/client-transcribe";
// Set the AWS Region.
const REGION = "REGION"; //e.g. "us-east-1"
// Create an Amazon Transcribe service client object.
const transcribeClient = new TranscribeClient({ region: REGION });
export { transcribeClient };
```
+ For more information, see [AWS SDK for JavaScript Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/transcribe-examples-section.html#transcribe-start-transcription).
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/transcribe/command/StartTranscriptionJobCommand) in *AWS SDK for JavaScript API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/transcribe#code-examples).
```
def start_job(
job_name,
media_uri,
media_format,
language_code,
transcribe_client,
vocabulary_name=None,
):
"""
Starts a transcription job. This function returns as soon as the job is started.
To get the current status of the job, call get_transcription_job. The job is
successfully completed when the job status is 'COMPLETED'.
:param job_name: The name of the transcription job. This must be unique for
your AWS account.
:param media_uri: The URI where the audio file is stored. This is typically
in an Amazon S3 bucket.
:param media_format: The format of the audio file. For example, mp3 or wav.
:param language_code: The language code of the audio file.
For example, en-US or ja-JP
:param transcribe_client: The Boto3 Transcribe client.
:param vocabulary_name: The name of a custom vocabulary to use when transcribing
the audio file.
:return: Data about the job.
"""
try:
job_args = {
"TranscriptionJobName": job_name,
"Media": {"MediaFileUri": media_uri},
"MediaFormat": media_format,
"LanguageCode": language_code,
}
if vocabulary_name is not None:
job_args["Settings"] = {"VocabularyName": vocabulary_name}
response = transcribe_client.start_transcription_job(**job_args)
job = response["TranscriptionJob"]
logger.info("Started transcription job %s.", job_name)
except ClientError:
logger.exception("Couldn't start transcription job %s.", job_name)
raise
else:
return job
```
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/goto/boto3/transcribe-2017-10-26/StartTranscriptionJob) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/tnb#code-examples).
```
TRY.
DATA(lo_media) = NEW /aws1/cl_tnbmedia( iv_mediafileuri = iv_media_uri ).
DATA(lo_settings) = NEW /aws1/cl_tnbsettings( ).
IF iv_vocabulary_name IS NOT INITIAL.
lo_settings = NEW /aws1/cl_tnbsettings( iv_vocabularyname = iv_vocabulary_name ).
ENDIF.
oo_result = lo_tnb->starttranscriptionjob(
iv_transcriptionjobname = iv_job_name
io_media = lo_media
iv_mediaformat = iv_media_format
iv_languagecode = iv_language_code
io_settings = lo_settings ).
MESSAGE 'Transcription job started.' TYPE 'I'.
CATCH /aws1/cx_tnbbadrequestex INTO DATA(lo_bad_request_ex).
MESSAGE lo_bad_request_ex TYPE 'I'.
RAISE EXCEPTION lo_bad_request_ex.
CATCH /aws1/cx_tnblimitexceededex INTO DATA(lo_limit_ex).
MESSAGE lo_limit_ex TYPE 'I'.
RAISE EXCEPTION lo_limit_ex.
CATCH /aws1/cx_tnbinternalfailureex INTO DATA(lo_internal_ex).
MESSAGE lo_internal_ex TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
CATCH /aws1/cx_tnbconflictexception INTO DATA(lo_conflict_ex).
MESSAGE lo_conflict_ex TYPE 'I'.
RAISE EXCEPTION lo_conflict_ex.
ENDTRY.
```
+ For API details, see [StartTranscriptionJob](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------