Amazonka.Transcribe.Types.CallAnalyticsJob

Documentation

data CallAnalyticsJob

Provides detailed information about a 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 the RedactedMediaFileUri field of your response.

See: newCallAnalyticsJob smart constructor.

Constructors

CallAnalyticsJob'

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 the specified 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.

• channelDefinitions :: Maybe (NonEmpty ChannelDefinition)

  Indicates which speaker is on which channel.

• 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.

• dataAccessRoleArn :: Maybe Text

  The Amazon Resource Name (ARN) you included in your request.

• failureReason :: Maybe Text

  If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

  The FailureReason field contains one of the following values:

  • Unsupported media format.

    The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

  • The media format provided does not match the detected media format.

    The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

  • Invalid sample rate for audio file.

    The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

  • The sample rate provided does not match the detected sample rate.

    The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

  • Invalid file size: file size too large.

    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

  • Invalid number of channels: number of channels too large.

    Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

• identifiedLanguageScore :: Maybe Double

  The confidence score associated with the language identified in your media file.

  Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

• languageCode :: Maybe LanguageCode

  The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

  If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

• media :: Maybe Media

  Provides the Amazon S3 location of the media file you used in your Call Analytics request.

• mediaFormat :: Maybe MediaFormat

  The format of the input media file.

• mediaSampleRateHertz :: Maybe Natural

  The sample rate, in hertz, of the audio track in your input media file.

• settings :: Maybe CallAnalyticsJobSettings

  Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

• startTime :: Maybe POSIX

  The date and time the specified 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.

• transcript :: Maybe Transcript

Instances

FromJSON CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

parseJSON :: Value -> Parser CallAnalyticsJob

parseJSONList :: Value -> Parser [CallAnalyticsJob]

Generic CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Associated Types

type Rep CallAnalyticsJob :: Type -> Type

Methods

from :: CallAnalyticsJob -> Rep CallAnalyticsJob x

to :: Rep CallAnalyticsJob x -> CallAnalyticsJob

Read CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

readsPrec :: Int -> ReadS CallAnalyticsJob

readList :: ReadS [CallAnalyticsJob]

readPrec :: ReadPrec CallAnalyticsJob

readListPrec :: ReadPrec [CallAnalyticsJob]

Show CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

showsPrec :: Int -> CallAnalyticsJob -> ShowS

show :: CallAnalyticsJob -> String

showList :: [CallAnalyticsJob] -> ShowS

NFData CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

rnf :: CallAnalyticsJob -> ()

Eq CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

(==) :: CallAnalyticsJob -> CallAnalyticsJob -> Bool

(/=) :: CallAnalyticsJob -> CallAnalyticsJob -> Bool

Hashable CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

Methods

hashWithSalt :: Int -> CallAnalyticsJob -> Int

hash :: CallAnalyticsJob -> Int

type Rep CallAnalyticsJob

Defined in Amazonka.Transcribe.Types.CallAnalyticsJob

type Rep CallAnalyticsJob = D1 ('MetaData "CallAnalyticsJob" "Amazonka.Transcribe.Types.CallAnalyticsJob" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "CallAnalyticsJob'" '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 "channelDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ChannelDefinition))))) :*: ((S1 ('MetaSel ('Just "completionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "identifiedLanguageScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode))) :*: (S1 ('MetaSel ('Just "media") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Media)) :*: S1 ('MetaSel ('Just "mediaFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MediaFormat)))) :*: ((S1 ('MetaSel ('Just "mediaSampleRateHertz") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAnalyticsJobSettings))) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "transcript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Transcript)))))))

newCallAnalyticsJob :: CallAnalyticsJob

Create a value of CallAnalyticsJob 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:CallAnalyticsJob', callAnalyticsJob_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:CallAnalyticsJob', callAnalyticsJob_callAnalyticsJobStatus - Provides the status of the specified 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:channelDefinitions:CallAnalyticsJob', callAnalyticsJob_channelDefinitions - Indicates which speaker is on which channel.

$sel:completionTime:CallAnalyticsJob', callAnalyticsJob_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:CallAnalyticsJob', callAnalyticsJob_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:dataAccessRoleArn:CallAnalyticsJob', callAnalyticsJob_dataAccessRoleArn - The Amazon Resource Name (ARN) you included in your request.

$sel:failureReason:CallAnalyticsJob', callAnalyticsJob_failureReason - If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

$sel:identifiedLanguageScore:CallAnalyticsJob', callAnalyticsJob_identifiedLanguageScore - The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

$sel:languageCode:CallAnalyticsJob', callAnalyticsJob_languageCode - The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

$sel:media:CallAnalyticsJob', callAnalyticsJob_media - Provides the Amazon S3 location of the media file you used in your Call Analytics request.

$sel:mediaFormat:CallAnalyticsJob', callAnalyticsJob_mediaFormat - The format of the input media file.

$sel:mediaSampleRateHertz:CallAnalyticsJob', callAnalyticsJob_mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.

$sel:settings:CallAnalyticsJob', callAnalyticsJob_settings - Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

$sel:startTime:CallAnalyticsJob', callAnalyticsJob_startTime - The date and time the specified 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.

$sel:transcript:CallAnalyticsJob', callAnalyticsJob_transcript - Undocumented member.

callAnalyticsJob_callAnalyticsJobName :: Lens' CallAnalyticsJob (Maybe Text)

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

callAnalyticsJob_callAnalyticsJobStatus :: Lens' CallAnalyticsJob (Maybe CallAnalyticsJobStatus)

Provides the status of the specified 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.

callAnalyticsJob_channelDefinitions :: Lens' CallAnalyticsJob (Maybe (NonEmpty ChannelDefinition))

Indicates which speaker is on which channel.

callAnalyticsJob_completionTime :: Lens' CallAnalyticsJob (Maybe UTCTime)

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.

callAnalyticsJob_creationTime :: Lens' CallAnalyticsJob (Maybe UTCTime)

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.

callAnalyticsJob_dataAccessRoleArn :: Lens' CallAnalyticsJob (Maybe Text)

The Amazon Resource Name (ARN) you included in your request.

callAnalyticsJob_failureReason :: Lens' CallAnalyticsJob (Maybe Text)

If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.

callAnalyticsJob_identifiedLanguageScore :: Lens' CallAnalyticsJob (Maybe Double)

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

callAnalyticsJob_languageCode :: Lens' CallAnalyticsJob (Maybe LanguageCode)

The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table.

If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.

callAnalyticsJob_media :: Lens' CallAnalyticsJob (Maybe Media)

Provides the Amazon S3 location of the media file you used in your Call Analytics request.

callAnalyticsJob_mediaFormat :: Lens' CallAnalyticsJob (Maybe MediaFormat)

The format of the input media file.

callAnalyticsJob_mediaSampleRateHertz :: Lens' CallAnalyticsJob (Maybe Natural)

The sample rate, in hertz, of the audio track in your input media file.

callAnalyticsJob_settings :: Lens' CallAnalyticsJob (Maybe CallAnalyticsJobSettings)

Provides information on any additional settings that were included in your request. Additional settings include content redaction and language identification settings.

callAnalyticsJob_startTime :: Lens' CallAnalyticsJob (Maybe UTCTime)

The date and time the specified 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.

callAnalyticsJob_transcript :: Lens' CallAnalyticsJob (Maybe Transcript)

Undocumented member.