amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.GetCallAnalyticsJob

Description

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.

Synopsis

Creating a Request

data GetCallAnalyticsJob Source #

See: newGetCallAnalyticsJob smart constructor.

Constructors

GetCallAnalyticsJob' 

Fields

  • callAnalyticsJobName :: Text

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

Instances

Instances details
ToJSON GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

ToHeaders GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

ToPath GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

ToQuery GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

AWSRequest GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Associated Types

type AWSResponse GetCallAnalyticsJob #

Generic GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Associated Types

type Rep GetCallAnalyticsJob :: Type -> Type #

Read GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Show GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

NFData GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Methods

rnf :: GetCallAnalyticsJob -> () #

Eq GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Hashable GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

type AWSResponse GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

type Rep GetCallAnalyticsJob Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

type Rep GetCallAnalyticsJob = D1 ('MetaData "GetCallAnalyticsJob" "Amazonka.Transcribe.GetCallAnalyticsJob" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "GetCallAnalyticsJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callAnalyticsJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetCallAnalyticsJob Source #

Create a value of GetCallAnalyticsJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

Request Lenses

getCallAnalyticsJob_callAnalyticsJobName :: Lens' GetCallAnalyticsJob Text Source #

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

Destructuring the Response

data GetCallAnalyticsJobResponse Source #

See: newGetCallAnalyticsJobResponse smart constructor.

Constructors

GetCallAnalyticsJobResponse' 

Fields

Instances

Instances details
Generic GetCallAnalyticsJobResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Associated Types

type Rep GetCallAnalyticsJobResponse :: Type -> Type #

Read GetCallAnalyticsJobResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Show GetCallAnalyticsJobResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

NFData GetCallAnalyticsJobResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

Eq GetCallAnalyticsJobResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

type Rep GetCallAnalyticsJobResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetCallAnalyticsJob

type Rep GetCallAnalyticsJobResponse = D1 ('MetaData "GetCallAnalyticsJobResponse" "Amazonka.Transcribe.GetCallAnalyticsJob" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "GetCallAnalyticsJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "callAnalyticsJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJob)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetCallAnalyticsJobResponse Source #

Create a value of GetCallAnalyticsJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:callAnalyticsJob:GetCallAnalyticsJobResponse', getCallAnalyticsJobResponse_callAnalyticsJob - Provides detailed information about the specified Call Analytics job, including job status and, if applicable, failure reason.

$sel:httpStatus:GetCallAnalyticsJobResponse', getCallAnalyticsJobResponse_httpStatus - The response's http status code.

Response Lenses

getCallAnalyticsJobResponse_callAnalyticsJob :: Lens' GetCallAnalyticsJobResponse (Maybe CallAnalyticsJob) Source #

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