@datafire/amazonaws_transcribe

Client library for Amazon Transcribe Service

Installation and Usage

npm install --save @datafire/amazonaws_transcribe

let amazonaws_transcribe = require('@datafire/amazonaws_transcribe').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_transcribe.GetTranscriptionJob({
  "TranscriptionJobName": ""
}).then(data => {
  console.log(data);
});

Description

Operations and objects for transcribing speech to text.

Actions

GetTranscriptionJob

amazonaws_transcribe.GetTranscriptionJob({
  "TranscriptionJobName": ""
}, context)

Input

• input object
  • TranscriptionJobName required TranscriptionJobName

Output

• output GetTranscriptionJobResponse

ListTranscriptionJobs

amazonaws_transcribe.ListTranscriptionJobs({
  "Status": ""
}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults MaxResults
  • NextToken NextToken
  • Status required TranscriptionJobStatus

Output

• output ListTranscriptionJobsResponse

StartTranscriptionJob

amazonaws_transcribe.StartTranscriptionJob({
  "TranscriptionJobName": "",
  "LanguageCode": "",
  "MediaFormat": "",
  "Media": {}
}, context)

Input

• input object
  • LanguageCode required LanguageCode
  • Media required Media
  • MediaFormat required MediaFormat
  • MediaSampleRateHertz MediaSampleRateHertz
  • TranscriptionJobName required TranscriptionJobName

Output

• output StartTranscriptionJobResponse

Definitions

BadRequestException

• BadRequestException object: There is a problem with one of the input fields. Check the S3 bucket name, make sure that the job name is not a duplicate, and confirm that you are using the correct file format. Then resend your request.
  • Message FailureReason

ConflictException

• ConflictException object: The JobName field is a duplicate of a previously entered job name. Resend your request with a different name.
  • Message String

DateTime

• DateTime string

FailureReason

• FailureReason string

GetTranscriptionJobRequest

• GetTranscriptionJobRequest object
  • TranscriptionJobName required TranscriptionJobName

GetTranscriptionJobResponse

• GetTranscriptionJobResponse object
  • TranscriptionJob TranscriptionJob

InternalFailureException

• InternalFailureException object: There was an internal error. Check the error message and try your request again.
  • Message String

LanguageCode

• LanguageCode string (values: en-US, es-US)

LimitExceededException

• LimitExceededException object: Either you have sent too many requests or your input file is longer than 2 hours. Wait before you resend your request, or use a smaller file and resend the request.
  • Message String

ListTranscriptionJobsRequest

• ListTranscriptionJobsRequest object
  • MaxResults MaxResults
  • NextToken NextToken
  • Status required TranscriptionJobStatus

ListTranscriptionJobsResponse

• ListTranscriptionJobsResponse object
  • NextToken NextToken
  • Status TranscriptionJobStatus
  • TranscriptionJobSummaries TranscriptionJobSummaries

MaxResults

• MaxResults integer

Media

• Media object: Describes the input media file in a transcription request.
  • MediaFileUri Uri

MediaFormat

• MediaFormat string (values: mp3, mp4, wav, flac)

MediaSampleRateHertz

• MediaSampleRateHertz integer

NextToken

• NextToken string

NotFoundException

• NotFoundException object: We can't find the requested job. Check the job name and try your request again.
  • Message String

StartTranscriptionJobRequest

• StartTranscriptionJobRequest object
  • LanguageCode required LanguageCode
  • Media required Media
  • MediaFormat required MediaFormat
  • MediaSampleRateHertz MediaSampleRateHertz
  • TranscriptionJobName required TranscriptionJobName

StartTranscriptionJobResponse

• StartTranscriptionJobResponse object
  • TranscriptionJob TranscriptionJob

String

• String string

Transcript

• Transcript object: Describes the output of a transcription job.
  • TranscriptFileUri Uri

TranscriptionJob

• TranscriptionJob object: Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.
  • CompletionTime DateTime
  • CreationTime DateTime
  • FailureReason FailureReason
  • LanguageCode LanguageCode
  • Media Media
  • MediaFormat MediaFormat
  • MediaSampleRateHertz MediaSampleRateHertz
  • Transcript Transcript
  • TranscriptionJobName TranscriptionJobName
  • TranscriptionJobStatus TranscriptionJobStatus

TranscriptionJobName

• TranscriptionJobName string

TranscriptionJobStatus

• TranscriptionJobStatus string (values: IN_PROGRESS, FAILED, COMPLETED)

TranscriptionJobSummaries

• TranscriptionJobSummaries array
  • items TranscriptionJobSummary

TranscriptionJobSummary

• TranscriptionJobSummary object: Provides a summary of information about a transcription job.
  • CompletionTime DateTime
  • CreationTime DateTime
  • FailureReason FailureReason
  • LanguageCode LanguageCode
  • TranscriptionJobName TranscriptionJobName
  • TranscriptionJobStatus TranscriptionJobStatus

Uri

• Uri string