CallAnalyticsJobSummary
Provides detailed information about a specific Call Analytics job.
Contents
- CallAnalyticsJobName
-
The name of the Call Analytics job. Job names are case sensitive and must be unique within an AWS account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+
Required: No
- CallAnalyticsJobStatus
-
Provides the status of your Call Analytics job.
If the status is
COMPLETED
, the job is finished and you can find the results at the location specified inTranscriptFileUri
(orRedactedTranscriptFileUri
, if you requested transcript redaction). If the status isFAILED
,FailureReason
provides details on why your transcription job failed.Type: String
Valid Values:
QUEUED | IN_PROGRESS | FAILED | COMPLETED
Required: No
- CompletionTime
-
The date and time the specified Call Analytics job finished processing.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:33:13.922000-07:00
represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.Type: Timestamp
Required: No
- CreationTime
-
The date and time the specified Call Analytics job request was made.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.Type: Timestamp
Required: No
- FailureReason
-
If
CallAnalyticsJobStatus
isFAILED
,FailureReason
contains information about why the Call Analytics job failed. See also: Common Errors.Type: String
Required: No
- LanguageCode
-
The language code used to create your Call Analytics transcription.
Type: String
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
Required: No
- StartTime
-
The date and time your Call Analytics job began processing.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.789000-07:00
represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: