View a markdown version of this page

GetCallAnalyticsJob - Amazon Transcribe

GetCallAnalyticsJob

Provides information about the specified Call Analytics job.

To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri.

If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri.

To get a list of your Call Analytics jobs, use the ListCallAnalyticsJobs operation.

Request Syntax

{ "CallAnalyticsJobName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CallAnalyticsJobName

The name of the Call Analytics job you want information about. Job names are case sensitive.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: Yes

Response Syntax

{ "CallAnalyticsJob": { "CallAnalyticsJobDetails": { "Skipped": [ { "Feature": "string", "Message": "string", "ReasonCode": "string" } ] }, "CallAnalyticsJobName": "string", "CallAnalyticsJobStatus": "string", "ChannelDefinitions": [ { "ChannelId": number, "ParticipantRole": "string" } ], "CompletionTime": number, "CreationTime": number, "DataAccessRoleArn": "string", "FailureReason": "string", "IdentifiedLanguageScore": number, "LanguageCode": "string", "Media": { "MediaFileUri": "string", "RedactedMediaFileUri": "string" }, "MediaFormat": "string", "MediaSampleRateHertz": number, "Settings": { "ContentRedaction": { "PiiEntityTypes": [ "string" ], "RedactionOutput": "string", "RedactionType": "string" }, "LanguageIdSettings": { "string" : { "LanguageModelName": "string", "VocabularyFilterName": "string", "VocabularyName": "string" } }, "LanguageModelName": "string", "LanguageOptions": [ "string" ], "Summarization": { "GenerateAbstractiveSummary": boolean }, "VocabularyFilterMethod": "string", "VocabularyFilterName": "string", "VocabularyName": "string" }, "StartTime": number, "Tags": [ { "Key": "string", "Value": "string" } ], "Transcript": { "RedactedTranscriptFileUri": "string", "TranscriptFileUri": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CallAnalyticsJob

Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

Type: CallAnalyticsJob object

Errors

For information about the errors that are common to all actions, see Common Error Types.

BadRequestException

Your request didn't pass one or more validation tests. This can occur when a parameter has an invalid value, when you combine parameters in a way that isn't supported, when the entity you're trying to delete doesn't exist, or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

Reason

A code that identifies why the audio in your request was rejected. Currently, TranscribeAudio returns this field, and only for problems with your audio. It isn't returned for other validation errors.

Possible values:

  • audioTooLong: The audio is longer than the maximum duration of 1 hour.

  • audioTooShort: The audio is shorter than 0.5 seconds.

  • audioFileTooLarge: The audio is larger than the maximum size.

  • unsupportedAudioFormat: The media format isn't supported.

  • unsupportedChannelCount: You enabled ChannelIdentification and the audio has more than two channels.

  • invalidAudio: Amazon Transcribe couldn't decode the audio.

  • mediaDownloadFailed: Amazon Transcribe couldn't download the audio at your MediaFileUri.

HTTP Status Code: 400

InternalFailureException

There was an internal error. Check the error message, correct the issue, and try your request again.

HTTP Status Code: 500

LimitExceededException

You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

HTTP Status Code: 400

NotFoundException

We can't find the requested resource. Check that the specified name is correct and try your request again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: