Icon

AWS Transcribe (version v1.*.*)

create_vocabulary

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

Parameters

$body

Type: object

{
"LanguageCode" : "The language code of the vocabulary entries.",
"VocabularyName" : "The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.",
"Phrases" : [ "string" ],
"VocabularyFileUri" : "The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is \n https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> \nFor example: \n https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt \nFor more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. \nFor more information about custom vocabularies, see Custom Vocabularies."
}

delete_transcription_job

Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

Parameters

$body

Type: object

{
"TranscriptionJobName" : "The name of the transcription job to be deleted."
}

delete_vocabulary

Deletes a vocabulary from Amazon Transcribe.

Parameters

$body

Type: object

{
"VocabularyName" : "The name of the vocabulary to delete. "
}

get_transcription_job

Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

Parameters

$body

Type: object

{
"TranscriptionJobName" : "The name of the job."
}

get_vocabulary

Gets information about a vocabulary.

Parameters

$body

Type: object

{
"VocabularyName" : "The name of the vocabulary to return information about. The name is case-sensitive."
}

list_transcription_jobs

Lists transcription jobs with the specified status.

Parameters

$body

Type: object

{
"Status" : "When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date. ",
"JobNameContains" : "When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.",
"NextToken" : "If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.",
"MaxResults" : "The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results."
}

list_vocabularies

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Parameters

$body

Type: object

{
"NextToken" : "If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.",
"StateEquals" : "When specified, only returns vocabularies with the VocabularyState field equal to the specified state.",
"MaxResults" : "The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.",
"NameContains" : "When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both \"vocabularyname\" and \"VocabularyName\" in the response list."
}

start_transcription_job

Starts an asynchronous job to transcribe speech to text.

Parameters

$body

Type: object

{
"MediaFormat" : "The format of the input media file.",
"TranscriptionJobName" : "The name of the job. Note that you can't use the strings \".\" or \"..\" by themselves as the job name. The name must also be unique within an AWS account.",
"LanguageCode" : "The language code for the language used in the input media file.",
"OutputBucketName" : "The location where the transcription is stored. \nIf you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles. \nAmazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key. \nIf you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.",
"Media" : {
"MediaFileUri" : "The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is: \n https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> \nFor example: \n https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4 \n https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4 \nFor more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide."
},
"MediaSampleRateHertz" : "The sample rate, in Hertz, of the audio track in the input media file. \nIf you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.",
"OutputEncryptionKMSKeyId" : "string",
"Settings" : {
"MaxSpeakerLabels" : "The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.",
"VocabularyName" : "The name of a vocabulary to use when processing the transcription job.",
"ChannelIdentification" : "Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription. \nAmazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription. \nYou can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.",
"ShowSpeakerLabels" : "Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field. \nYou can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException."
}
}

update_vocabulary

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Parameters

$body

Type: object

{
"LanguageCode" : "The language code of the vocabulary entries.",
"VocabularyName" : "The name of the vocabulary to update. The name is case-sensitive.",
"Phrases" : [ "string" ],
"VocabularyFileUri" : "The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is \n https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> \nFor example: \n https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt \nFor more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. \nFor more information about custom vocabularies, see Custom Vocabularies."
}