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.Types.CallAnalyticsJobSummary

Description

 
Synopsis

Documentation

data CallAnalyticsJobSummary Source #

Provides detailed information about a specific Call Analytics job.

See: newCallAnalyticsJobSummary smart constructor.

Constructors

CallAnalyticsJobSummary' 

Fields

  • callAnalyticsJobName :: Maybe Text

    The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

  • callAnalyticsJobStatus :: Maybe 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 in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

  • completionTime :: Maybe POSIX

    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.

  • creationTime :: Maybe POSIX

    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.

  • failureReason :: Maybe Text

    If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

  • languageCode :: Maybe LanguageCode

    The language code used to create your Call Analytics transcription.

  • startTime :: Maybe POSIX

    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.

Instances

Instances details
FromJSON CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

Generic CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

Associated Types

type Rep CallAnalyticsJobSummary :: Type -> Type #

Read CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

Show CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

NFData CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

Methods

rnf :: CallAnalyticsJobSummary -> () #

Eq CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

Hashable CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

type Rep CallAnalyticsJobSummary Source # 
Instance details

Defined in Amazonka.Transcribe.Types.CallAnalyticsJobSummary

type Rep CallAnalyticsJobSummary = D1 ('MetaData "CallAnalyticsJobSummary" "Amazonka.Transcribe.Types.CallAnalyticsJobSummary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "CallAnalyticsJobSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAnalyticsJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "callAnalyticsJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobStatus)) :*: S1 ('MetaSel ('Just "completionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newCallAnalyticsJobSummary :: CallAnalyticsJobSummary Source #

Create a value of CallAnalyticsJobSummary 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:callAnalyticsJobName:CallAnalyticsJobSummary', callAnalyticsJobSummary_callAnalyticsJobName - The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

$sel:callAnalyticsJobStatus:CallAnalyticsJobSummary', callAnalyticsJobSummary_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 in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

$sel:completionTime:CallAnalyticsJobSummary', callAnalyticsJobSummary_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.

$sel:creationTime:CallAnalyticsJobSummary', callAnalyticsJobSummary_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.

$sel:failureReason:CallAnalyticsJobSummary', callAnalyticsJobSummary_failureReason - If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

$sel:languageCode:CallAnalyticsJobSummary', callAnalyticsJobSummary_languageCode - The language code used to create your Call Analytics transcription.

$sel:startTime:CallAnalyticsJobSummary', callAnalyticsJobSummary_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.

callAnalyticsJobSummary_callAnalyticsJobName :: Lens' CallAnalyticsJobSummary (Maybe Text) Source #

The name of the Call Analytics job. Job names are case sensitive and must be unique within an Amazon Web Services account.

callAnalyticsJobSummary_callAnalyticsJobStatus :: Lens' CallAnalyticsJobSummary (Maybe CallAnalyticsJobStatus) Source #

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 in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

callAnalyticsJobSummary_completionTime :: Lens' CallAnalyticsJobSummary (Maybe UTCTime) Source #

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.

callAnalyticsJobSummary_creationTime :: Lens' CallAnalyticsJobSummary (Maybe UTCTime) Source #

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.

callAnalyticsJobSummary_failureReason :: Lens' CallAnalyticsJobSummary (Maybe Text) Source #

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job failed. See also: Common Errors.

callAnalyticsJobSummary_languageCode :: Lens' CallAnalyticsJobSummary (Maybe LanguageCode) Source #

The language code used to create your Call Analytics transcription.

callAnalyticsJobSummary_startTime :: Lens' CallAnalyticsJobSummary (Maybe UTCTime) Source #

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.