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 operation.
Parameters:
-
call_analytics_job_name
(CallAnalyticsJobName)
–
The name of the Call Analytics job you want information about. Job names are case sensitive.
Raises:
-
BadRequestException
–
Your request didn't pass one or more validation tests. This can occur 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.
-
InternalFailureException
–
There was an internal error. Check the error message, correct the issue, and try your request again.
-
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.
-
NotFoundException
–
We can't find the requested resource. Check that the specified name is correct and try your request again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_transcribe/_services/transcribe.py
| def get_call_analytics_job(
self,
call_analytics_job_name: "capo_transcribe.types.call_analytics_job_name.CallAnalyticsJobName",
*,
config_overrides: Optional[TranscribeClientConfig] = None,
) -> "capo_transcribe.types.get_call_analytics_job_response.GetCallAnalyticsJobResponse":
"""<p>Provides information about the specified Call Analytics job.</p> <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status is <code>COMPLETED</code>, the job is finished. You can find your completed transcript at the URI specified in <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why your transcription job failed.</p> <p>If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in <code>RedactedTranscriptFileUri</code>.</p> <p>If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in <code>RedactedMediaFileUri</code>.</p> <p>To get a list of your Call Analytics jobs, use the operation.</p>
Args:
call_analytics_job_name: <p>The name of the Call Analytics job you want information about. Job names are case sensitive.</p>
Raises:
capo_transcribe.errors.bad_request_exception.BadRequestException: <p>Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as <code>IN PROGRESS</code>). See the exception message field for more information.</p>
capo_transcribe.errors.internal_failure_exception.InternalFailureException: <p>There was an internal error. Check the error message, correct the issue, and try your request again.</p>
capo_transcribe.errors.limit_exceeded_exception.LimitExceededException: <p>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.</p>
capo_transcribe.errors.not_found_exception.NotFoundException: <p>We can't find the requested resource. Check that the specified name is correct and try your request again.</p>
capo_transcribe.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_transcribe.types.get_call_analytics_job_request.GetCallAnalyticsJobRequest]",
) -> OperationResponse[
"capo_transcribe.types.get_call_analytics_job_response.GetCallAnalyticsJobResponse"
]:
import capo_transcribe._operations.transcribe.get_call_analytics_job
output, http_response = (
capo_transcribe._operations.transcribe.get_call_analytics_job.get_call_analytics_job(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetCallAnalyticsJob")
)
input_: capo_transcribe.types.get_call_analytics_job_request.GetCallAnalyticsJobRequest = {
"call_analytics_job_name": call_analytics_job_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|