Skip to main content
Version: 2.1

ITranscribeCallAnalyticsJob

Interface in AWS.Transcribe

Interface for CallAnalyticsJob.

Properties​

CallAnalyticsJobName​

property CallAnalyticsJobName: string

The name of the Call Analytics job.

CallAnalyticsJobStatus​

property CallAnalyticsJobStatus: string

The status of the Call Analytics job.

Valid values: QUEUED | IN_PROGRESS | FAILED | COMPLETED. If the status is COMPLETED, the job is finished and the results can be found at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

ChannelDefinitions​

property ChannelDefinitions: TList<ITranscribeChannelDefinition>

Type: ITranscribeChannelDefinition

Indicates which speaker is on which channel.

CompletionTime​

property CompletionTime: TOptional<TDateTime>

The date and time the Call Analytics job finished processing.

CreationTime​

property CreationTime: TOptional<TDateTime>

The date and time the Call Analytics job was created.

DataAccessRoleArn​

property DataAccessRoleArn: TARN

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket specified at creation.

FailureReason​

property FailureReason: string

The reason for failure.

Returned if the CallAnalyticsJobStatus is FAILED. FailureReason may be one of the followoing:

IdentifiedLanguageScore​

property IdentifiedLanguageScore: TOptional<Single>

The confidence score associated with the language identified in the media input file.

Confidence scores are between 0 and 1. A larger value indicates a higher probability that the identified language is correct.

LanguageCode​

property LanguageCode: string

The language code that used to create the Call Analytics job.

Valid values: af-ZA | ar-AE | ar-SA | da-DK | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fa-IR | fr-CA | fr-FR | he-IL | hi-IN | id-ID | it-IT | ja-JP | ko-KR | ms-MY | nl-NL | pt-BR | pt-PT | ru-RU | ta-IN | te-IN | tr-TR | zh-CN | zh-TW | th-TH | en-ZA | en-NZ | vi-VN | sv-SE.

Media​

property Media: ITranscribeMedia

Type: ITranscribeMedia

The Amazon S3 location of the media file used when creating the Call Analytics job.

MediaFormat​

property MediaFormat: string

The format of the input media file.

Valid values: mp3 | mp4 | wav | flac | ogg | amr | webm.

MediaSampleRateHertz​

property MediaSampleRateHertz: TOptional<Integer>

The sample rate, in hertz, of the audio track in the input media file.

Settings​

property Settings: ITranscribeCallAnalyticsJobSettings

Type: ITranscribeCallAnalyticsJobSettings

Information about additional settings that were included in the job request.

StartTime​

property StartTime: TOptional<TDateTime>

The date and time the Call Analytics job began processing.

Transcript​

property Transcript: ITranscribeTranscript

Type: ITranscribeTranscript

The Amazon S3 location (URI) you can use to access the transcript.