| Copyright | (c) 2013-2023 Brendan Hay | 
|---|---|
| License | Mozilla Public License, v. 2.0. | 
| Maintainer | Brendan Hay | 
| Stability | auto-generated | 
| Portability | non-portable (GHC extensions) | 
| Safe Haskell | Safe-Inferred | 
| Language | Haskell2010 | 
Amazonka.Transcribe
Contents
- Service Configuration
 - Errors
 - Waiters
 - Operations
- CreateCallAnalyticsCategory
 - CreateLanguageModel
 - CreateMedicalVocabulary
 - CreateVocabulary
 - CreateVocabularyFilter
 - DeleteCallAnalyticsCategory
 - DeleteCallAnalyticsJob
 - DeleteLanguageModel
 - DeleteMedicalTranscriptionJob
 - DeleteMedicalVocabulary
 - DeleteTranscriptionJob
 - DeleteVocabulary
 - DeleteVocabularyFilter
 - DescribeLanguageModel
 - GetCallAnalyticsCategory
 - GetCallAnalyticsJob
 - GetMedicalTranscriptionJob
 - GetMedicalVocabulary
 - GetTranscriptionJob
 - GetVocabulary
 - GetVocabularyFilter
 - ListCallAnalyticsCategories
 - ListCallAnalyticsJobs
 - ListLanguageModels
 - ListMedicalTranscriptionJobs
 - ListMedicalVocabularies
 - ListTagsForResource
 - ListTranscriptionJobs
 - ListVocabularies
 - ListVocabularyFilters
 - StartCallAnalyticsJob
 - StartMedicalTranscriptionJob
 - StartTranscriptionJob
 - TagResource
 - UntagResource
 - UpdateCallAnalyticsCategory
 - UpdateMedicalVocabulary
 - UpdateVocabulary
 - UpdateVocabularyFilter
 
 - Types
- BaseModelName
 - CLMLanguageCode
 - CallAnalyticsJobStatus
 - InputType
 - LanguageCode
 - MediaFormat
 - MedicalContentIdentificationType
 - ModelStatus
 - OutputLocationType
 - ParticipantRole
 - PiiEntityType
 - RedactionOutput
 - RedactionType
 - SentimentValue
 - Specialty
 - SubtitleFormat
 - TranscriptFilterType
 - TranscriptionJobStatus
 - Type
 - VocabularyFilterMethod
 - VocabularyState
 - AbsoluteTimeRange
 - CallAnalyticsJob
 - CallAnalyticsJobSettings
 - CallAnalyticsJobSummary
 - CategoryProperties
 - ChannelDefinition
 - ContentRedaction
 - InputDataConfig
 - InterruptionFilter
 - JobExecutionSettings
 - LanguageCodeItem
 - LanguageIdSettings
 - LanguageModel
 - Media
 - MedicalTranscript
 - MedicalTranscriptionJob
 - MedicalTranscriptionJobSummary
 - MedicalTranscriptionSetting
 - ModelSettings
 - NonTalkTimeFilter
 - RelativeTimeRange
 - Rule
 - SentimentFilter
 - Settings
 - Subtitles
 - SubtitlesOutput
 - Tag
 - Transcript
 - TranscriptFilter
 - TranscriptionJob
 - TranscriptionJobSummary
 - VocabularyFilterInfo
 - VocabularyInfo
 
 
Description
Derived from API version 2017-10-26 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Transcribe offers three main types of batch transcription: Standard, Medical, and Call Analytics.
- Standard transcriptions are the most common option. Refer to for details.
 - Medical transcriptions are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue into after-visit notes. Refer to for details.
 - Call Analytics transcriptions are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details.
 
Synopsis
- defaultService :: Service
 - _BadRequestException :: AsError a => Fold a ServiceError
 - _ConflictException :: AsError a => Fold a ServiceError
 - _InternalFailureException :: AsError a => Fold a ServiceError
 - _LimitExceededException :: AsError a => Fold a ServiceError
 - _NotFoundException :: AsError a => Fold a ServiceError
 - data CreateCallAnalyticsCategory = CreateCallAnalyticsCategory' (Maybe InputType) Text (NonEmpty Rule)
 - newCreateCallAnalyticsCategory :: Text -> NonEmpty Rule -> CreateCallAnalyticsCategory
 - data CreateCallAnalyticsCategoryResponse = CreateCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int
 - newCreateCallAnalyticsCategoryResponse :: Int -> CreateCallAnalyticsCategoryResponse
 - data CreateLanguageModel = CreateLanguageModel' (Maybe (NonEmpty Tag)) CLMLanguageCode BaseModelName Text InputDataConfig
 - newCreateLanguageModel :: CLMLanguageCode -> BaseModelName -> Text -> InputDataConfig -> CreateLanguageModel
 - data CreateLanguageModelResponse = CreateLanguageModelResponse' (Maybe BaseModelName) (Maybe InputDataConfig) (Maybe CLMLanguageCode) (Maybe Text) (Maybe ModelStatus) Int
 - newCreateLanguageModelResponse :: Int -> CreateLanguageModelResponse
 - data CreateMedicalVocabulary = CreateMedicalVocabulary' (Maybe (NonEmpty Tag)) Text LanguageCode Text
 - newCreateMedicalVocabulary :: Text -> LanguageCode -> Text -> CreateMedicalVocabulary
 - data CreateMedicalVocabularyResponse = CreateMedicalVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int
 - newCreateMedicalVocabularyResponse :: Int -> CreateMedicalVocabularyResponse
 - data CreateVocabulary = CreateVocabulary' (Maybe [Text]) (Maybe (NonEmpty Tag)) (Maybe Text) Text LanguageCode
 - newCreateVocabulary :: Text -> LanguageCode -> CreateVocabulary
 - data CreateVocabularyResponse = CreateVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int
 - newCreateVocabularyResponse :: Int -> CreateVocabularyResponse
 - data CreateVocabularyFilter = CreateVocabularyFilter' (Maybe (NonEmpty Tag)) (Maybe Text) (Maybe (NonEmpty Text)) Text LanguageCode
 - newCreateVocabularyFilter :: Text -> LanguageCode -> CreateVocabularyFilter
 - data CreateVocabularyFilterResponse = CreateVocabularyFilterResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int
 - newCreateVocabularyFilterResponse :: Int -> CreateVocabularyFilterResponse
 - data DeleteCallAnalyticsCategory = DeleteCallAnalyticsCategory' Text
 - newDeleteCallAnalyticsCategory :: Text -> DeleteCallAnalyticsCategory
 - data DeleteCallAnalyticsCategoryResponse = DeleteCallAnalyticsCategoryResponse' Int
 - newDeleteCallAnalyticsCategoryResponse :: Int -> DeleteCallAnalyticsCategoryResponse
 - data DeleteCallAnalyticsJob = DeleteCallAnalyticsJob' Text
 - newDeleteCallAnalyticsJob :: Text -> DeleteCallAnalyticsJob
 - data DeleteCallAnalyticsJobResponse = DeleteCallAnalyticsJobResponse' Int
 - newDeleteCallAnalyticsJobResponse :: Int -> DeleteCallAnalyticsJobResponse
 - data DeleteLanguageModel = DeleteLanguageModel' Text
 - newDeleteLanguageModel :: Text -> DeleteLanguageModel
 - data DeleteLanguageModelResponse = DeleteLanguageModelResponse' {
 - newDeleteLanguageModelResponse :: DeleteLanguageModelResponse
 - data DeleteMedicalTranscriptionJob = DeleteMedicalTranscriptionJob' Text
 - newDeleteMedicalTranscriptionJob :: Text -> DeleteMedicalTranscriptionJob
 - data DeleteMedicalTranscriptionJobResponse = DeleteMedicalTranscriptionJobResponse' {
 - newDeleteMedicalTranscriptionJobResponse :: DeleteMedicalTranscriptionJobResponse
 - data DeleteMedicalVocabulary = DeleteMedicalVocabulary' Text
 - newDeleteMedicalVocabulary :: Text -> DeleteMedicalVocabulary
 - data DeleteMedicalVocabularyResponse = DeleteMedicalVocabularyResponse' {
 - newDeleteMedicalVocabularyResponse :: DeleteMedicalVocabularyResponse
 - data DeleteTranscriptionJob = DeleteTranscriptionJob' Text
 - newDeleteTranscriptionJob :: Text -> DeleteTranscriptionJob
 - data DeleteTranscriptionJobResponse = DeleteTranscriptionJobResponse' {
 - newDeleteTranscriptionJobResponse :: DeleteTranscriptionJobResponse
 - data DeleteVocabulary = DeleteVocabulary' Text
 - newDeleteVocabulary :: Text -> DeleteVocabulary
 - data DeleteVocabularyResponse = DeleteVocabularyResponse' {
 - newDeleteVocabularyResponse :: DeleteVocabularyResponse
 - data DeleteVocabularyFilter = DeleteVocabularyFilter' Text
 - newDeleteVocabularyFilter :: Text -> DeleteVocabularyFilter
 - data DeleteVocabularyFilterResponse = DeleteVocabularyFilterResponse' {
 - newDeleteVocabularyFilterResponse :: DeleteVocabularyFilterResponse
 - data DescribeLanguageModel = DescribeLanguageModel' Text
 - newDescribeLanguageModel :: Text -> DescribeLanguageModel
 - data DescribeLanguageModelResponse = DescribeLanguageModelResponse' (Maybe LanguageModel) Int
 - newDescribeLanguageModelResponse :: Int -> DescribeLanguageModelResponse
 - data GetCallAnalyticsCategory = GetCallAnalyticsCategory' Text
 - newGetCallAnalyticsCategory :: Text -> GetCallAnalyticsCategory
 - data GetCallAnalyticsCategoryResponse = GetCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int
 - newGetCallAnalyticsCategoryResponse :: Int -> GetCallAnalyticsCategoryResponse
 - data GetCallAnalyticsJob = GetCallAnalyticsJob' Text
 - newGetCallAnalyticsJob :: Text -> GetCallAnalyticsJob
 - data GetCallAnalyticsJobResponse = GetCallAnalyticsJobResponse' (Maybe CallAnalyticsJob) Int
 - newGetCallAnalyticsJobResponse :: Int -> GetCallAnalyticsJobResponse
 - data GetMedicalTranscriptionJob = GetMedicalTranscriptionJob' Text
 - newGetMedicalTranscriptionJob :: Text -> GetMedicalTranscriptionJob
 - data GetMedicalTranscriptionJobResponse = GetMedicalTranscriptionJobResponse' (Maybe MedicalTranscriptionJob) Int
 - newGetMedicalTranscriptionJobResponse :: Int -> GetMedicalTranscriptionJobResponse
 - data GetMedicalVocabulary = GetMedicalVocabulary' Text
 - newGetMedicalVocabulary :: Text -> GetMedicalVocabulary
 - data GetMedicalVocabularyResponse = GetMedicalVocabularyResponse' (Maybe Text) (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int
 - newGetMedicalVocabularyResponse :: Int -> GetMedicalVocabularyResponse
 - data GetTranscriptionJob = GetTranscriptionJob' Text
 - newGetTranscriptionJob :: Text -> GetTranscriptionJob
 - data GetTranscriptionJobResponse = GetTranscriptionJobResponse' (Maybe TranscriptionJob) Int
 - newGetTranscriptionJobResponse :: Int -> GetTranscriptionJobResponse
 - data GetVocabulary = GetVocabulary' Text
 - newGetVocabulary :: Text -> GetVocabulary
 - data GetVocabularyResponse = GetVocabularyResponse' (Maybe Text) (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int
 - newGetVocabularyResponse :: Int -> GetVocabularyResponse
 - data GetVocabularyFilter = GetVocabularyFilter' Text
 - newGetVocabularyFilter :: Text -> GetVocabularyFilter
 - data GetVocabularyFilterResponse = GetVocabularyFilterResponse' (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int
 - newGetVocabularyFilterResponse :: Int -> GetVocabularyFilterResponse
 - data ListCallAnalyticsCategories = ListCallAnalyticsCategories' (Maybe Natural) (Maybe Text)
 - newListCallAnalyticsCategories :: ListCallAnalyticsCategories
 - data ListCallAnalyticsCategoriesResponse = ListCallAnalyticsCategoriesResponse' (Maybe [CategoryProperties]) (Maybe Text) Int
 - newListCallAnalyticsCategoriesResponse :: Int -> ListCallAnalyticsCategoriesResponse
 - data ListCallAnalyticsJobs = ListCallAnalyticsJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe CallAnalyticsJobStatus)
 - newListCallAnalyticsJobs :: ListCallAnalyticsJobs
 - data ListCallAnalyticsJobsResponse = ListCallAnalyticsJobsResponse' (Maybe [CallAnalyticsJobSummary]) (Maybe Text) (Maybe CallAnalyticsJobStatus) Int
 - newListCallAnalyticsJobsResponse :: Int -> ListCallAnalyticsJobsResponse
 - data ListLanguageModels = ListLanguageModels' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ModelStatus)
 - newListLanguageModels :: ListLanguageModels
 - data ListLanguageModelsResponse = ListLanguageModelsResponse' (Maybe [LanguageModel]) (Maybe Text) Int
 - newListLanguageModelsResponse :: Int -> ListLanguageModelsResponse
 - data ListMedicalTranscriptionJobs = ListMedicalTranscriptionJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TranscriptionJobStatus)
 - newListMedicalTranscriptionJobs :: ListMedicalTranscriptionJobs
 - data ListMedicalTranscriptionJobsResponse = ListMedicalTranscriptionJobsResponse' (Maybe [MedicalTranscriptionJobSummary]) (Maybe Text) (Maybe TranscriptionJobStatus) Int
 - newListMedicalTranscriptionJobsResponse :: Int -> ListMedicalTranscriptionJobsResponse
 - data ListMedicalVocabularies = ListMedicalVocabularies' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe VocabularyState)
 - newListMedicalVocabularies :: ListMedicalVocabularies
 - data ListMedicalVocabulariesResponse = ListMedicalVocabulariesResponse' (Maybe Text) (Maybe VocabularyState) (Maybe [VocabularyInfo]) Int
 - newListMedicalVocabulariesResponse :: Int -> ListMedicalVocabulariesResponse
 - data ListTagsForResource = ListTagsForResource' Text
 - newListTagsForResource :: Text -> ListTagsForResource
 - data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (NonEmpty Tag)) Int
 - newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
 - data ListTranscriptionJobs = ListTranscriptionJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TranscriptionJobStatus)
 - newListTranscriptionJobs :: ListTranscriptionJobs
 - data ListTranscriptionJobsResponse = ListTranscriptionJobsResponse' (Maybe Text) (Maybe TranscriptionJobStatus) (Maybe [TranscriptionJobSummary]) Int
 - newListTranscriptionJobsResponse :: Int -> ListTranscriptionJobsResponse
 - data ListVocabularies = ListVocabularies' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe VocabularyState)
 - newListVocabularies :: ListVocabularies
 - data ListVocabulariesResponse = ListVocabulariesResponse' (Maybe Text) (Maybe VocabularyState) (Maybe [VocabularyInfo]) Int
 - newListVocabulariesResponse :: Int -> ListVocabulariesResponse
 - data ListVocabularyFilters = ListVocabularyFilters' (Maybe Natural) (Maybe Text) (Maybe Text)
 - newListVocabularyFilters :: ListVocabularyFilters
 - data ListVocabularyFiltersResponse = ListVocabularyFiltersResponse' (Maybe Text) (Maybe [VocabularyFilterInfo]) Int
 - newListVocabularyFiltersResponse :: Int -> ListVocabularyFiltersResponse
 - data StartCallAnalyticsJob = StartCallAnalyticsJob' (Maybe (NonEmpty ChannelDefinition)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CallAnalyticsJobSettings) Text Media
 - newStartCallAnalyticsJob :: Text -> Media -> StartCallAnalyticsJob
 - data StartCallAnalyticsJobResponse = StartCallAnalyticsJobResponse' (Maybe CallAnalyticsJob) Int
 - newStartCallAnalyticsJobResponse :: Int -> StartCallAnalyticsJobResponse
 - data StartMedicalTranscriptionJob = StartMedicalTranscriptionJob' (Maybe MedicalContentIdentificationType) (Maybe (HashMap Text Text)) (Maybe MediaFormat) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe MedicalTranscriptionSetting) (Maybe (NonEmpty Tag)) Text LanguageCode Media Text Specialty Type
 - newStartMedicalTranscriptionJob :: Text -> LanguageCode -> Media -> Text -> Specialty -> Type -> StartMedicalTranscriptionJob
 - data StartMedicalTranscriptionJobResponse = StartMedicalTranscriptionJobResponse' (Maybe MedicalTranscriptionJob) Int
 - newStartMedicalTranscriptionJobResponse :: Int -> StartMedicalTranscriptionJobResponse
 - data StartTranscriptionJob = StartTranscriptionJob' (Maybe ContentRedaction) (Maybe Bool) (Maybe Bool) (Maybe JobExecutionSettings) (Maybe (HashMap Text Text)) (Maybe LanguageCode) (Maybe (HashMap LanguageCode LanguageIdSettings)) (Maybe (NonEmpty LanguageCode)) (Maybe MediaFormat) (Maybe Natural) (Maybe ModelSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Settings) (Maybe Subtitles) (Maybe (NonEmpty Tag)) Text Media
 - newStartTranscriptionJob :: Text -> Media -> StartTranscriptionJob
 - data StartTranscriptionJobResponse = StartTranscriptionJobResponse' (Maybe TranscriptionJob) Int
 - newStartTranscriptionJobResponse :: Int -> StartTranscriptionJobResponse
 - data TagResource = TagResource' Text (NonEmpty Tag)
 - newTagResource :: Text -> NonEmpty Tag -> TagResource
 - data TagResourceResponse = TagResourceResponse' Int
 - newTagResourceResponse :: Int -> TagResourceResponse
 - data UntagResource = UntagResource' Text (NonEmpty Text)
 - newUntagResource :: Text -> NonEmpty Text -> UntagResource
 - data UntagResourceResponse = UntagResourceResponse' Int
 - newUntagResourceResponse :: Int -> UntagResourceResponse
 - data UpdateCallAnalyticsCategory = UpdateCallAnalyticsCategory' (Maybe InputType) Text (NonEmpty Rule)
 - newUpdateCallAnalyticsCategory :: Text -> NonEmpty Rule -> UpdateCallAnalyticsCategory
 - data UpdateCallAnalyticsCategoryResponse = UpdateCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int
 - newUpdateCallAnalyticsCategoryResponse :: Int -> UpdateCallAnalyticsCategoryResponse
 - data UpdateMedicalVocabulary = UpdateMedicalVocabulary' Text LanguageCode Text
 - newUpdateMedicalVocabulary :: Text -> LanguageCode -> Text -> UpdateMedicalVocabulary
 - data UpdateMedicalVocabularyResponse = UpdateMedicalVocabularyResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int
 - newUpdateMedicalVocabularyResponse :: Int -> UpdateMedicalVocabularyResponse
 - data UpdateVocabulary = UpdateVocabulary' (Maybe [Text]) (Maybe Text) Text LanguageCode
 - newUpdateVocabulary :: Text -> LanguageCode -> UpdateVocabulary
 - data UpdateVocabularyResponse = UpdateVocabularyResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int
 - newUpdateVocabularyResponse :: Int -> UpdateVocabularyResponse
 - data UpdateVocabularyFilter = UpdateVocabularyFilter' (Maybe Text) (Maybe (NonEmpty Text)) Text
 - newUpdateVocabularyFilter :: Text -> UpdateVocabularyFilter
 - data UpdateVocabularyFilterResponse = UpdateVocabularyFilterResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int
 - newUpdateVocabularyFilterResponse :: Int -> UpdateVocabularyFilterResponse
 - newtype BaseModelName where
- BaseModelName' { }
 - pattern BaseModelName_NarrowBand :: BaseModelName
 - pattern BaseModelName_WideBand :: BaseModelName
 
 - newtype CLMLanguageCode where
- CLMLanguageCode' { }
 - pattern CLMLanguageCode_De_DE :: CLMLanguageCode
 - pattern CLMLanguageCode_En_AU :: CLMLanguageCode
 - pattern CLMLanguageCode_En_GB :: CLMLanguageCode
 - pattern CLMLanguageCode_En_US :: CLMLanguageCode
 - pattern CLMLanguageCode_Es_US :: CLMLanguageCode
 - pattern CLMLanguageCode_Hi_IN :: CLMLanguageCode
 - pattern CLMLanguageCode_Ja_JP :: CLMLanguageCode
 
 - newtype CallAnalyticsJobStatus where
 - newtype InputType where
- InputType' { }
 - pattern InputType_POST_CALL :: InputType
 - pattern InputType_REAL_TIME :: InputType
 
 - newtype LanguageCode where
- LanguageCode' { }
 - pattern LanguageCode_Af_ZA :: LanguageCode
 - pattern LanguageCode_Ar_AE :: LanguageCode
 - pattern LanguageCode_Ar_SA :: LanguageCode
 - pattern LanguageCode_Da_DK :: LanguageCode
 - pattern LanguageCode_De_CH :: LanguageCode
 - pattern LanguageCode_De_DE :: LanguageCode
 - pattern LanguageCode_En_AB :: LanguageCode
 - pattern LanguageCode_En_AU :: LanguageCode
 - pattern LanguageCode_En_GB :: LanguageCode
 - pattern LanguageCode_En_IE :: LanguageCode
 - pattern LanguageCode_En_IN :: LanguageCode
 - pattern LanguageCode_En_NZ :: LanguageCode
 - pattern LanguageCode_En_US :: LanguageCode
 - pattern LanguageCode_En_WL :: LanguageCode
 - pattern LanguageCode_En_ZA :: LanguageCode
 - pattern LanguageCode_Es_ES :: LanguageCode
 - pattern LanguageCode_Es_US :: LanguageCode
 - pattern LanguageCode_Fa_IR :: LanguageCode
 - pattern LanguageCode_Fr_CA :: LanguageCode
 - pattern LanguageCode_Fr_FR :: LanguageCode
 - pattern LanguageCode_He_IL :: LanguageCode
 - pattern LanguageCode_Hi_IN :: LanguageCode
 - pattern LanguageCode_Id_ID :: LanguageCode
 - pattern LanguageCode_It_IT :: LanguageCode
 - pattern LanguageCode_Ja_JP :: LanguageCode
 - pattern LanguageCode_Ko_KR :: LanguageCode
 - pattern LanguageCode_Ms_MY :: LanguageCode
 - pattern LanguageCode_Nl_NL :: LanguageCode
 - pattern LanguageCode_Pt_BR :: LanguageCode
 - pattern LanguageCode_Pt_PT :: LanguageCode
 - pattern LanguageCode_Ru_RU :: LanguageCode
 - pattern LanguageCode_Sv_SE :: LanguageCode
 - pattern LanguageCode_Ta_IN :: LanguageCode
 - pattern LanguageCode_Te_IN :: LanguageCode
 - pattern LanguageCode_Th_TH :: LanguageCode
 - pattern LanguageCode_Tr_TR :: LanguageCode
 - pattern LanguageCode_Vi_VN :: LanguageCode
 - pattern LanguageCode_Zh_CN :: LanguageCode
 - pattern LanguageCode_Zh_TW :: LanguageCode
 
 - newtype MediaFormat where
- MediaFormat' { }
 - pattern MediaFormat_Amr :: MediaFormat
 - pattern MediaFormat_Flac :: MediaFormat
 - pattern MediaFormat_Mp3 :: MediaFormat
 - pattern MediaFormat_Mp4 :: MediaFormat
 - pattern MediaFormat_Ogg :: MediaFormat
 - pattern MediaFormat_Wav :: MediaFormat
 - pattern MediaFormat_Webm :: MediaFormat
 
 - newtype MedicalContentIdentificationType where
 - newtype ModelStatus where
- ModelStatus' { }
 - pattern ModelStatus_COMPLETED :: ModelStatus
 - pattern ModelStatus_FAILED :: ModelStatus
 - pattern ModelStatus_IN_PROGRESS :: ModelStatus
 
 - newtype OutputLocationType where
 - newtype ParticipantRole where
- ParticipantRole' { }
 - pattern ParticipantRole_AGENT :: ParticipantRole
 - pattern ParticipantRole_CUSTOMER :: ParticipantRole
 
 - newtype PiiEntityType where
- PiiEntityType' { }
 - pattern PiiEntityType_ADDRESS :: PiiEntityType
 - pattern PiiEntityType_ALL :: PiiEntityType
 - pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType
 - pattern PiiEntityType_BANK_ROUTING :: PiiEntityType
 - pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType
 - pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType
 - pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType
 - pattern PiiEntityType_EMAIL :: PiiEntityType
 - pattern PiiEntityType_NAME :: PiiEntityType
 - pattern PiiEntityType_PHONE :: PiiEntityType
 - pattern PiiEntityType_PIN :: PiiEntityType
 - pattern PiiEntityType_SSN :: PiiEntityType
 
 - newtype RedactionOutput where
- RedactionOutput' { }
 - pattern RedactionOutput_Redacted :: RedactionOutput
 - pattern RedactionOutput_Redacted_and_unredacted :: RedactionOutput
 
 - newtype RedactionType where
- RedactionType' { }
 - pattern RedactionType_PII :: RedactionType
 
 - newtype SentimentValue where
- SentimentValue' { }
 - pattern SentimentValue_MIXED :: SentimentValue
 - pattern SentimentValue_NEGATIVE :: SentimentValue
 - pattern SentimentValue_NEUTRAL :: SentimentValue
 - pattern SentimentValue_POSITIVE :: SentimentValue
 
 - newtype Specialty where
- Specialty' { }
 - pattern Specialty_PRIMARYCARE :: Specialty
 
 - newtype SubtitleFormat where
- SubtitleFormat' { }
 - pattern SubtitleFormat_Srt :: SubtitleFormat
 - pattern SubtitleFormat_Vtt :: SubtitleFormat
 
 - newtype TranscriptFilterType where
 - newtype TranscriptionJobStatus where
 - newtype Type where
- Type' { }
 - pattern Type_CONVERSATION :: Type
 - pattern Type_DICTATION :: Type
 
 - newtype VocabularyFilterMethod where
 - newtype VocabularyState where
- VocabularyState' { }
 - pattern VocabularyState_FAILED :: VocabularyState
 - pattern VocabularyState_PENDING :: VocabularyState
 - pattern VocabularyState_READY :: VocabularyState
 
 - data AbsoluteTimeRange = AbsoluteTimeRange' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural)
 - newAbsoluteTimeRange :: AbsoluteTimeRange
 - data CallAnalyticsJob = CallAnalyticsJob' (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe (NonEmpty ChannelDefinition)) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe LanguageCode) (Maybe Media) (Maybe MediaFormat) (Maybe Natural) (Maybe CallAnalyticsJobSettings) (Maybe POSIX) (Maybe Transcript)
 - newCallAnalyticsJob :: CallAnalyticsJob
 - data CallAnalyticsJobSettings = CallAnalyticsJobSettings' (Maybe ContentRedaction) (Maybe (HashMap LanguageCode LanguageIdSettings)) (Maybe Text) (Maybe (NonEmpty LanguageCode)) (Maybe VocabularyFilterMethod) (Maybe Text) (Maybe Text)
 - newCallAnalyticsJobSettings :: CallAnalyticsJobSettings
 - data CallAnalyticsJobSummary = CallAnalyticsJobSummary' (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe LanguageCode) (Maybe POSIX)
 - newCallAnalyticsJobSummary :: CallAnalyticsJobSummary
 - data CategoryProperties = CategoryProperties' (Maybe Text) (Maybe POSIX) (Maybe InputType) (Maybe POSIX) (Maybe (NonEmpty Rule))
 - newCategoryProperties :: CategoryProperties
 - data ChannelDefinition = ChannelDefinition' (Maybe Natural) (Maybe ParticipantRole)
 - newChannelDefinition :: ChannelDefinition
 - data ContentRedaction = ContentRedaction' (Maybe [PiiEntityType]) RedactionType RedactionOutput
 - newContentRedaction :: RedactionType -> RedactionOutput -> ContentRedaction
 - data InputDataConfig = InputDataConfig' (Maybe Text) Text Text
 - newInputDataConfig :: Text -> Text -> InputDataConfig
 - data InterruptionFilter = InterruptionFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Natural)
 - newInterruptionFilter :: InterruptionFilter
 - data JobExecutionSettings = JobExecutionSettings' (Maybe Bool) (Maybe Text)
 - newJobExecutionSettings :: JobExecutionSettings
 - data LanguageCodeItem = LanguageCodeItem' (Maybe Double) (Maybe LanguageCode)
 - newLanguageCodeItem :: LanguageCodeItem
 - data LanguageIdSettings = LanguageIdSettings' (Maybe Text) (Maybe Text) (Maybe Text)
 - newLanguageIdSettings :: LanguageIdSettings
 - data LanguageModel = LanguageModel' (Maybe BaseModelName) (Maybe POSIX) (Maybe Text) (Maybe InputDataConfig) (Maybe CLMLanguageCode) (Maybe POSIX) (Maybe Text) (Maybe ModelStatus) (Maybe Bool)
 - newLanguageModel :: LanguageModel
 - data Media = Media' (Maybe Text) (Maybe Text)
 - newMedia :: Media
 - data MedicalTranscript = MedicalTranscript' (Maybe Text)
 - newMedicalTranscript :: MedicalTranscript
 - data MedicalTranscriptionJob = MedicalTranscriptionJob' (Maybe POSIX) (Maybe MedicalContentIdentificationType) (Maybe POSIX) (Maybe Text) (Maybe LanguageCode) (Maybe Media) (Maybe MediaFormat) (Maybe Natural) (Maybe Text) (Maybe MedicalTranscriptionSetting) (Maybe Specialty) (Maybe POSIX) (Maybe (NonEmpty Tag)) (Maybe MedicalTranscript) (Maybe TranscriptionJobStatus) (Maybe Type)
 - newMedicalTranscriptionJob :: MedicalTranscriptionJob
 - data MedicalTranscriptionJobSummary = MedicalTranscriptionJobSummary' (Maybe POSIX) (Maybe MedicalContentIdentificationType) (Maybe POSIX) (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe OutputLocationType) (Maybe Specialty) (Maybe POSIX) (Maybe TranscriptionJobStatus) (Maybe Type)
 - newMedicalTranscriptionJobSummary :: MedicalTranscriptionJobSummary
 - data MedicalTranscriptionSetting = MedicalTranscriptionSetting' (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text)
 - newMedicalTranscriptionSetting :: MedicalTranscriptionSetting
 - data ModelSettings = ModelSettings' (Maybe Text)
 - newModelSettings :: ModelSettings
 - data NonTalkTimeFilter = NonTalkTimeFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe RelativeTimeRange) (Maybe Natural)
 - newNonTalkTimeFilter :: NonTalkTimeFilter
 - data RelativeTimeRange = RelativeTimeRange' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural)
 - newRelativeTimeRange :: RelativeTimeRange
 - data Rule = Rule' (Maybe InterruptionFilter) (Maybe NonTalkTimeFilter) (Maybe SentimentFilter) (Maybe TranscriptFilter)
 - newRule :: Rule
 - data SentimentFilter = SentimentFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe ParticipantRole) (Maybe RelativeTimeRange) (NonEmpty SentimentValue)
 - newSentimentFilter :: NonEmpty SentimentValue -> SentimentFilter
 - data Settings = Settings' (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe VocabularyFilterMethod) (Maybe Text) (Maybe Text)
 - newSettings :: Settings
 - data Subtitles = Subtitles' (Maybe [SubtitleFormat]) (Maybe Natural)
 - newSubtitles :: Subtitles
 - data SubtitlesOutput = SubtitlesOutput' (Maybe [SubtitleFormat]) (Maybe Natural) (Maybe [Text])
 - newSubtitlesOutput :: SubtitlesOutput
 - data Tag = Tag' Text Text
 - newTag :: Text -> Text -> Tag
 - data Transcript = Transcript' (Maybe Text) (Maybe Text)
 - newTranscript :: Transcript
 - data TranscriptFilter = TranscriptFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe ParticipantRole) (Maybe RelativeTimeRange) TranscriptFilterType (NonEmpty Text)
 - newTranscriptFilter :: TranscriptFilterType -> NonEmpty Text -> TranscriptFilter
 - data TranscriptionJob = TranscriptionJob' (Maybe POSIX) (Maybe ContentRedaction) (Maybe POSIX) (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe JobExecutionSettings) (Maybe LanguageCode) (Maybe [LanguageCodeItem]) (Maybe (HashMap LanguageCode LanguageIdSettings)) (Maybe (NonEmpty LanguageCode)) (Maybe Media) (Maybe MediaFormat) (Maybe Natural) (Maybe ModelSettings) (Maybe Settings) (Maybe POSIX) (Maybe SubtitlesOutput) (Maybe (NonEmpty Tag)) (Maybe Transcript) (Maybe Text) (Maybe TranscriptionJobStatus)
 - newTranscriptionJob :: TranscriptionJob
 - data TranscriptionJobSummary = TranscriptionJobSummary' (Maybe POSIX) (Maybe ContentRedaction) (Maybe POSIX) (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe LanguageCode) (Maybe [LanguageCodeItem]) (Maybe ModelSettings) (Maybe OutputLocationType) (Maybe POSIX) (Maybe Text) (Maybe TranscriptionJobStatus)
 - newTranscriptionJobSummary :: TranscriptionJobSummary
 - data VocabularyFilterInfo = VocabularyFilterInfo' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text)
 - newVocabularyFilterInfo :: VocabularyFilterInfo
 - data VocabularyInfo = VocabularyInfo' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState)
 - newVocabularyInfo :: VocabularyInfo
 
Service Configuration
defaultService :: Service Source #
API version 2017-10-26 of the Amazon Transcribe Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
 Control.Exception.Lens.
 This allows catching (and rethrowing) service specific errors returned
 by Transcribe.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
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.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
A resource already exists with this name. Resource names must be unique within an Amazon Web Services account.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
There was an internal error. Check the error message, correct the issue, and try your request again.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
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
_NotFoundException :: AsError a => Fold a ServiceError Source #
We can't find the requested resource. Check that the specified name is correct and try your request again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
 configured by the Wait specification is fulfilled. The Wait specification
 determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
 requests in order to obtain the entire result set. The process of sending
 subsequent requests to continue where a previous request left off is called
 pagination. For example, the ListObjects operation of Amazon S3 returns up to
 1000 objects at a time, and you must send subsequent requests with the
 appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
 requests, correctly setting Markers and other request facets to iterate through
 the entire result set of a truncated API operation. Operations which support
 this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateCallAnalyticsCategory
data CreateCallAnalyticsCategory Source #
See: newCreateCallAnalyticsCategory smart constructor.
Instances
newCreateCallAnalyticsCategory Source #
Arguments
| :: Text | |
| -> NonEmpty Rule | |
| -> CreateCallAnalyticsCategory | 
Create a value of CreateCallAnalyticsCategory 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:
CreateCallAnalyticsCategory, createCallAnalyticsCategory_inputType - Choose whether you want to create a streaming or a batch category for
 your Call Analytics transcription.
Specifying POST_CALL assigns your category to batch transcriptions;
 categories with this input type cannot be applied to streaming
 (real-time) transcriptions.
Specifying REAL_TIME assigns your category to streaming
 transcriptions; categories with this input type cannot be applied to
 batch (post-call) transcriptions.
If you do not include InputType, your category is created as a batch
 category by default.
CreateCallAnalyticsCategory, createCallAnalyticsCategory_categoryName - A unique name, chosen by you, for your Call Analytics category. It's
 helpful to use a detailed naming system that will make sense to you in
 the future. For example, it's better to use
 sentiment-positive-last30seconds for a category over a generic name
 like test-category.
Category names are case sensitive.
CreateCallAnalyticsCategory, createCallAnalyticsCategory_rules - Rules define a Call Analytics category. When creating a new category,
 you must create between 1 and 20 rules for that category. For each rule,
 you specify a filter you want applied to the attributes of a call. For
 example, you can choose a sentiment filter that detects if a customer's
 sentiment was positive during the last 30 seconds of the call.
data CreateCallAnalyticsCategoryResponse Source #
See: newCreateCallAnalyticsCategoryResponse smart constructor.
Constructors
| CreateCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int | 
Instances
newCreateCallAnalyticsCategoryResponse Source #
Arguments
| :: Int | |
| -> CreateCallAnalyticsCategoryResponse | 
Create a value of CreateCallAnalyticsCategoryResponse 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:categoryProperties:CreateCallAnalyticsCategoryResponse', createCallAnalyticsCategoryResponse_categoryProperties - Provides you with the properties of your new category, including its
 associated rules.
$sel:httpStatus:CreateCallAnalyticsCategoryResponse', createCallAnalyticsCategoryResponse_httpStatus - The response's http status code.
CreateLanguageModel
data CreateLanguageModel Source #
See: newCreateLanguageModel smart constructor.
Constructors
| CreateLanguageModel' (Maybe (NonEmpty Tag)) CLMLanguageCode BaseModelName Text InputDataConfig | 
Instances
newCreateLanguageModel Source #
Arguments
| :: CLMLanguageCode | |
| -> BaseModelName | |
| -> Text | |
| -> InputDataConfig | |
| -> CreateLanguageModel | 
Create a value of CreateLanguageModel 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:
CreateLanguageModel, createLanguageModel_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
 new custom language model at the time you create this new model.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
CreateLanguageModel, createLanguageModel_languageCode - The language code that represents the language of your model. Each
 custom language model must contain terms in only one language, and the
 language you select for your custom language model must match the
 language of your training and tuning data.
For a list of supported languages and their associated language codes,
 refer to the
 Supported languages
 table. Note that US English (en-US) is the only language supported
 with Amazon Transcribe Medical.
A custom language model can only be used to transcribe files in the same
 language as the model. For example, if you create a custom language
 model using US English (en-US), you can only apply this model to files
 that contain English audio.
CreateLanguageModel, createLanguageModel_baseModelName - The Amazon Transcribe standard language model, or base model, used to
 create your custom language model. Amazon Transcribe offers two options
 for base models: Wideband and Narrowband.
If the audio you want to transcribe has a sample rate of 16,000 Hz or
 greater, choose WideBand. To transcribe audio with a sample rate less
 than 16,000 Hz, choose NarrowBand.
CreateLanguageModel, createLanguageModel_modelName - A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new custom
 language model with the same name as an existing custom language model,
 you get a ConflictException error.
CreateLanguageModel, createLanguageModel_inputDataConfig - Contains the Amazon S3 location of the training data you want to use to
 create a new custom language model, and permissions to access this
 location.
When using InputDataConfig, you must include these sub-parameters:
 S3Uri, which is the Amazon S3 location of your training data, and
 DataAccessRoleArn, which is the Amazon Resource Name (ARN) of the role
 that has permission to access your specified Amazon S3 location. You can
 optionally include TuningDataS3Uri, which is the Amazon S3 location of
 your tuning data. If you specify different Amazon S3 locations for
 training and tuning data, the ARN you use must have permissions to
 access both locations.
data CreateLanguageModelResponse Source #
See: newCreateLanguageModelResponse smart constructor.
Constructors
| CreateLanguageModelResponse' (Maybe BaseModelName) (Maybe InputDataConfig) (Maybe CLMLanguageCode) (Maybe Text) (Maybe ModelStatus) Int | 
Instances
newCreateLanguageModelResponse Source #
Create a value of CreateLanguageModelResponse 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:
CreateLanguageModel, createLanguageModelResponse_baseModelName - The Amazon Transcribe standard language model, or base model, you
 specified when creating your custom language model.
CreateLanguageModel, createLanguageModelResponse_inputDataConfig - Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
 locations you provided for your training (S3Uri) and tuning
 (TuningDataS3Uri) data.
CreateLanguageModel, createLanguageModelResponse_languageCode - The language code you selected for your custom language model.
CreateLanguageModel, createLanguageModelResponse_modelName - The name of your custom language model.
CreateLanguageModelResponse, createLanguageModelResponse_modelStatus - The status of your custom language model. When the status displays as
 COMPLETED, your model is ready to use.
$sel:httpStatus:CreateLanguageModelResponse', createLanguageModelResponse_httpStatus - The response's http status code.
CreateMedicalVocabulary
data CreateMedicalVocabulary Source #
See: newCreateMedicalVocabulary smart constructor.
Constructors
| CreateMedicalVocabulary' (Maybe (NonEmpty Tag)) Text LanguageCode Text | 
Instances
newCreateMedicalVocabulary Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> Text | |
| -> CreateMedicalVocabulary | 
Create a value of CreateMedicalVocabulary 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:
CreateMedicalVocabulary, createMedicalVocabulary_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
 new custom medical vocabulary at the time you create this new custom
 vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
CreateMedicalVocabulary, createMedicalVocabulary_vocabularyName - A unique name, chosen by you, for your new custom medical vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new custom
 medical vocabulary with the same name as an existing custom medical
 vocabulary, you get a ConflictException error.
CreateMedicalVocabulary, createMedicalVocabulary_languageCode - The language code that represents the language of the entries in your
 custom vocabulary. US English (en-US) is the only language supported
 with Amazon Transcribe Medical.
$sel:vocabularyFileUri:CreateMedicalVocabulary', createMedicalVocabulary_vocabularyFileUri - The Amazon S3 location (URI) of the text file that contains your custom
 medical vocabulary. The URI must be in the same Amazon Web Services
 Region as the resource you're calling.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
data CreateMedicalVocabularyResponse Source #
See: newCreateMedicalVocabularyResponse smart constructor.
Constructors
| CreateMedicalVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int | 
Instances
newCreateMedicalVocabularyResponse Source #
Create a value of CreateMedicalVocabularyResponse 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:
CreateMedicalVocabularyResponse, createMedicalVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information
 about why the medical transcription job request failed. See also:
 Common Errors.
CreateMedicalVocabulary, createMedicalVocabularyResponse_languageCode - The language code you selected for your custom medical vocabulary. US
 English (en-US) is the only language supported with Amazon Transcribe
 Medical.
CreateMedicalVocabularyResponse, createMedicalVocabularyResponse_lastModifiedTime - The date and time you created your custom medical vocabulary.
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 12:32 PM UTC-7 on
 May 4, 2022.
CreateMedicalVocabulary, createMedicalVocabularyResponse_vocabularyName - The name you chose for your custom medical vocabulary.
CreateMedicalVocabularyResponse, createMedicalVocabularyResponse_vocabularyState - The processing state of your custom medical vocabulary. If the state is
 READY, you can use the custom vocabulary in a
 StartMedicalTranscriptionJob request.
$sel:httpStatus:CreateMedicalVocabularyResponse', createMedicalVocabularyResponse_httpStatus - The response's http status code.
CreateVocabulary
data CreateVocabulary Source #
See: newCreateVocabulary smart constructor.
Constructors
| CreateVocabulary' (Maybe [Text]) (Maybe (NonEmpty Tag)) (Maybe Text) Text LanguageCode | 
Instances
Arguments
| :: Text | |
| -> LanguageCode | |
| -> CreateVocabulary | 
Create a value of CreateVocabulary 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:phrases:CreateVocabulary', createVocabulary_phrases - Use this parameter if you want to create your custom vocabulary by
 including all desired terms, as comma-separated values, within your
 request. The other option for creating your custom vocabulary is to save
 your entries in a text file and upload them to an Amazon S3 bucket, then
 specify the location of your file using the VocabularyFileUri
 parameter.
Note that if you include Phrases in your request, you cannot use
 VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
CreateVocabulary, createVocabulary_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
 new custom vocabulary at the time you create this new custom vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
$sel:vocabularyFileUri:CreateVocabulary', createVocabulary_vocabularyFileUri - The Amazon S3 location of the text file that contains your custom
 vocabulary. The URI must be located in the same Amazon Web Services
 Region as the resource you're calling.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot
 use the Phrases flag; you must choose one or the other.
CreateVocabulary, createVocabulary_vocabularyName - A unique name, chosen by you, for your new custom vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new custom
 vocabulary with the same name as an existing custom vocabulary, you get
 a ConflictException error.
CreateVocabulary, createVocabulary_languageCode - The language code that represents the language of the entries in your
 custom vocabulary. Each custom vocabulary must contain terms in only one
 language.
A custom vocabulary can only be used to transcribe files in the same
 language as the custom vocabulary. For example, if you create a custom
 vocabulary using US English (en-US), you can only apply this custom
 vocabulary to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
data CreateVocabularyResponse Source #
See: newCreateVocabularyResponse smart constructor.
Constructors
| CreateVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int | 
Instances
newCreateVocabularyResponse Source #
Create a value of CreateVocabularyResponse 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:
CreateVocabularyResponse, createVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information
 about why the custom vocabulary request failed. See also:
 Common Errors.
CreateVocabulary, createVocabularyResponse_languageCode - The language code you selected for your custom vocabulary.
CreateVocabularyResponse, createVocabularyResponse_lastModifiedTime - The date and time you created your custom vocabulary.
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 12:32 PM UTC-7 on
 May 4, 2022.
CreateVocabulary, createVocabularyResponse_vocabularyName - The name you chose for your custom vocabulary.
CreateVocabularyResponse, createVocabularyResponse_vocabularyState - The processing state of your custom vocabulary. If the state is READY,
 you can use the custom vocabulary in a StartTranscriptionJob request.
$sel:httpStatus:CreateVocabularyResponse', createVocabularyResponse_httpStatus - The response's http status code.
CreateVocabularyFilter
data CreateVocabularyFilter Source #
See: newCreateVocabularyFilter smart constructor.
Constructors
| CreateVocabularyFilter' (Maybe (NonEmpty Tag)) (Maybe Text) (Maybe (NonEmpty Text)) Text LanguageCode | 
Instances
newCreateVocabularyFilter Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> CreateVocabularyFilter | 
Create a value of CreateVocabularyFilter 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:
CreateVocabularyFilter, createVocabularyFilter_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
 new custom vocabulary filter at the time you create this new vocabulary
 filter.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
$sel:vocabularyFilterFileUri:CreateVocabularyFilter', createVocabularyFilter_vocabularyFilterFileUri - The Amazon S3 location of the text file that contains your custom
 vocabulary filter terms. The URI must be located in the same Amazon Web
 Services Region as the resource you're calling.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you
 cannot use Words; you must choose one or the other.
$sel:words:CreateVocabularyFilter', createVocabularyFilter_words - Use this parameter if you want to create your custom vocabulary filter
 by including all desired terms, as comma-separated values, within your
 request. The other option for creating your vocabulary filter is to save
 your entries in a text file and upload them to an Amazon S3 bucket, then
 specify the location of your file using the VocabularyFilterFileUri
 parameter.
Note that if you include Words in your request, you cannot use
 VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
CreateVocabularyFilter, createVocabularyFilter_vocabularyFilterName - A unique name, chosen by you, for your new custom vocabulary filter.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new custom
 vocabulary filter with the same name as an existing custom vocabulary
 filter, you get a ConflictException error.
CreateVocabularyFilter, createVocabularyFilter_languageCode - The language code that represents the language of the entries in your
 vocabulary filter. Each custom vocabulary filter must contain terms in
 only one language.
A custom vocabulary filter can only be used to transcribe files in the
 same language as the filter. For example, if you create a custom
 vocabulary filter using US English (en-US), you can only apply this
 filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
data CreateVocabularyFilterResponse Source #
See: newCreateVocabularyFilterResponse smart constructor.
Constructors
| CreateVocabularyFilterResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int | 
Instances
newCreateVocabularyFilterResponse Source #
Create a value of CreateVocabularyFilterResponse 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:
CreateVocabularyFilter, createVocabularyFilterResponse_languageCode - The language code you selected for your custom vocabulary filter.
CreateVocabularyFilterResponse, createVocabularyFilterResponse_lastModifiedTime - The date and time you created your custom vocabulary filter.
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 12:32 PM UTC-7 on
 May 4, 2022.
CreateVocabularyFilter, createVocabularyFilterResponse_vocabularyFilterName - The name you chose for your custom vocabulary filter.
$sel:httpStatus:CreateVocabularyFilterResponse', createVocabularyFilterResponse_httpStatus - The response's http status code.
DeleteCallAnalyticsCategory
data DeleteCallAnalyticsCategory Source #
See: newDeleteCallAnalyticsCategory smart constructor.
Constructors
| DeleteCallAnalyticsCategory' Text | 
Instances
newDeleteCallAnalyticsCategory Source #
Arguments
| :: Text | |
| -> DeleteCallAnalyticsCategory | 
Create a value of DeleteCallAnalyticsCategory 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:
DeleteCallAnalyticsCategory, deleteCallAnalyticsCategory_categoryName - The name of the Call Analytics category you want to delete. Category
 names are case sensitive.
data DeleteCallAnalyticsCategoryResponse Source #
See: newDeleteCallAnalyticsCategoryResponse smart constructor.
Constructors
| DeleteCallAnalyticsCategoryResponse' Int | 
Instances
newDeleteCallAnalyticsCategoryResponse Source #
Arguments
| :: Int | |
| -> DeleteCallAnalyticsCategoryResponse | 
Create a value of DeleteCallAnalyticsCategoryResponse 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:httpStatus:DeleteCallAnalyticsCategoryResponse', deleteCallAnalyticsCategoryResponse_httpStatus - The response's http status code.
DeleteCallAnalyticsJob
data DeleteCallAnalyticsJob Source #
See: newDeleteCallAnalyticsJob smart constructor.
Constructors
| DeleteCallAnalyticsJob' Text | 
Instances
newDeleteCallAnalyticsJob Source #
Arguments
| :: Text | |
| -> DeleteCallAnalyticsJob | 
Create a value of DeleteCallAnalyticsJob 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:
DeleteCallAnalyticsJob, deleteCallAnalyticsJob_callAnalyticsJobName - The name of the Call Analytics job you want to delete. Job names are
 case sensitive.
data DeleteCallAnalyticsJobResponse Source #
See: newDeleteCallAnalyticsJobResponse smart constructor.
Constructors
| DeleteCallAnalyticsJobResponse' Int | 
Instances
newDeleteCallAnalyticsJobResponse Source #
Create a value of DeleteCallAnalyticsJobResponse 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:httpStatus:DeleteCallAnalyticsJobResponse', deleteCallAnalyticsJobResponse_httpStatus - The response's http status code.
DeleteLanguageModel
data DeleteLanguageModel Source #
See: newDeleteLanguageModel smart constructor.
Constructors
| DeleteLanguageModel' Text | 
Instances
newDeleteLanguageModel Source #
Arguments
| :: Text | |
| -> DeleteLanguageModel | 
Create a value of DeleteLanguageModel 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:
DeleteLanguageModel, deleteLanguageModel_modelName - The name of the custom language model you want to delete. Model names
 are case sensitive.
data DeleteLanguageModelResponse Source #
See: newDeleteLanguageModelResponse smart constructor.
Constructors
| DeleteLanguageModelResponse' | |
Instances
newDeleteLanguageModelResponse :: DeleteLanguageModelResponse Source #
Create a value of DeleteLanguageModelResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMedicalTranscriptionJob
data DeleteMedicalTranscriptionJob Source #
See: newDeleteMedicalTranscriptionJob smart constructor.
Constructors
| DeleteMedicalTranscriptionJob' Text | 
Instances
newDeleteMedicalTranscriptionJob Source #
Create a value of DeleteMedicalTranscriptionJob 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:
DeleteMedicalTranscriptionJob, deleteMedicalTranscriptionJob_medicalTranscriptionJobName - The name of the medical transcription job you want to delete. Job names
 are case sensitive.
data DeleteMedicalTranscriptionJobResponse Source #
See: newDeleteMedicalTranscriptionJobResponse smart constructor.
Constructors
| DeleteMedicalTranscriptionJobResponse' | |
Instances
newDeleteMedicalTranscriptionJobResponse :: DeleteMedicalTranscriptionJobResponse Source #
Create a value of DeleteMedicalTranscriptionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMedicalVocabulary
data DeleteMedicalVocabulary Source #
See: newDeleteMedicalVocabulary smart constructor.
Constructors
| DeleteMedicalVocabulary' Text | 
Instances
newDeleteMedicalVocabulary Source #
Arguments
| :: Text | |
| -> DeleteMedicalVocabulary | 
Create a value of DeleteMedicalVocabulary 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:
DeleteMedicalVocabulary, deleteMedicalVocabulary_vocabularyName - The name of the custom medical vocabulary you want to delete. Custom
 medical vocabulary names are case sensitive.
data DeleteMedicalVocabularyResponse Source #
See: newDeleteMedicalVocabularyResponse smart constructor.
Constructors
| DeleteMedicalVocabularyResponse' | |
Instances
| Generic DeleteMedicalVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalVocabulary Associated Types type Rep DeleteMedicalVocabularyResponse :: Type -> Type #  | |
| Read DeleteMedicalVocabularyResponse Source # | |
| Show DeleteMedicalVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalVocabulary Methods showsPrec :: Int -> DeleteMedicalVocabularyResponse -> ShowS #  | |
| NFData DeleteMedicalVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalVocabulary Methods rnf :: DeleteMedicalVocabularyResponse -> () #  | |
| Eq DeleteMedicalVocabularyResponse Source # | |
| type Rep DeleteMedicalVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalVocabulary  | |
newDeleteMedicalVocabularyResponse :: DeleteMedicalVocabularyResponse Source #
Create a value of DeleteMedicalVocabularyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteTranscriptionJob
data DeleteTranscriptionJob Source #
See: newDeleteTranscriptionJob smart constructor.
Constructors
| DeleteTranscriptionJob' Text | 
Instances
newDeleteTranscriptionJob Source #
Arguments
| :: Text | |
| -> DeleteTranscriptionJob | 
Create a value of DeleteTranscriptionJob 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:
DeleteTranscriptionJob, deleteTranscriptionJob_transcriptionJobName - The name of the transcription job you want to delete. Job names are case
 sensitive.
data DeleteTranscriptionJobResponse Source #
See: newDeleteTranscriptionJobResponse smart constructor.
Constructors
| DeleteTranscriptionJobResponse' | |
Instances
| Generic DeleteTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteTranscriptionJob Associated Types type Rep DeleteTranscriptionJobResponse :: Type -> Type #  | |
| Read DeleteTranscriptionJobResponse Source # | |
| Show DeleteTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteTranscriptionJob Methods showsPrec :: Int -> DeleteTranscriptionJobResponse -> ShowS # show :: DeleteTranscriptionJobResponse -> String # showList :: [DeleteTranscriptionJobResponse] -> ShowS #  | |
| NFData DeleteTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteTranscriptionJob Methods rnf :: DeleteTranscriptionJobResponse -> () #  | |
| Eq DeleteTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteTranscriptionJob  | |
| type Rep DeleteTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteTranscriptionJob  | |
newDeleteTranscriptionJobResponse :: DeleteTranscriptionJobResponse Source #
Create a value of DeleteTranscriptionJobResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVocabulary
data DeleteVocabulary Source #
See: newDeleteVocabulary smart constructor.
Constructors
| DeleteVocabulary' Text | 
Instances
Arguments
| :: Text | |
| -> DeleteVocabulary | 
Create a value of DeleteVocabulary 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:
DeleteVocabulary, deleteVocabulary_vocabularyName - The name of the custom vocabulary you want to delete. Custom vocabulary
 names are case sensitive.
data DeleteVocabularyResponse Source #
See: newDeleteVocabularyResponse smart constructor.
Constructors
| DeleteVocabularyResponse' | |
Instances
newDeleteVocabularyResponse :: DeleteVocabularyResponse Source #
Create a value of DeleteVocabularyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVocabularyFilter
data DeleteVocabularyFilter Source #
See: newDeleteVocabularyFilter smart constructor.
Constructors
| DeleteVocabularyFilter' Text | 
Instances
newDeleteVocabularyFilter Source #
Arguments
| :: Text | |
| -> DeleteVocabularyFilter | 
Create a value of DeleteVocabularyFilter 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:
DeleteVocabularyFilter, deleteVocabularyFilter_vocabularyFilterName - The name of the custom vocabulary filter you want to delete. Custom
 vocabulary filter names are case sensitive.
data DeleteVocabularyFilterResponse Source #
See: newDeleteVocabularyFilterResponse smart constructor.
Constructors
| DeleteVocabularyFilterResponse' | |
Instances
| Generic DeleteVocabularyFilterResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabularyFilter Associated Types type Rep DeleteVocabularyFilterResponse :: Type -> Type #  | |
| Read DeleteVocabularyFilterResponse Source # | |
| Show DeleteVocabularyFilterResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabularyFilter Methods showsPrec :: Int -> DeleteVocabularyFilterResponse -> ShowS # show :: DeleteVocabularyFilterResponse -> String # showList :: [DeleteVocabularyFilterResponse] -> ShowS #  | |
| NFData DeleteVocabularyFilterResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabularyFilter Methods rnf :: DeleteVocabularyFilterResponse -> () #  | |
| Eq DeleteVocabularyFilterResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabularyFilter  | |
| type Rep DeleteVocabularyFilterResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabularyFilter  | |
newDeleteVocabularyFilterResponse :: DeleteVocabularyFilterResponse Source #
Create a value of DeleteVocabularyFilterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeLanguageModel
data DescribeLanguageModel Source #
See: newDescribeLanguageModel smart constructor.
Constructors
| DescribeLanguageModel' Text | 
Instances
newDescribeLanguageModel Source #
Arguments
| :: Text | |
| -> DescribeLanguageModel | 
Create a value of DescribeLanguageModel 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:
DescribeLanguageModel, describeLanguageModel_modelName - The name of the custom language model you want information about. Model
 names are case sensitive.
data DescribeLanguageModelResponse Source #
See: newDescribeLanguageModelResponse smart constructor.
Constructors
| DescribeLanguageModelResponse' (Maybe LanguageModel) Int | 
Instances
newDescribeLanguageModelResponse Source #
Create a value of DescribeLanguageModelResponse 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:languageModel:DescribeLanguageModelResponse', describeLanguageModelResponse_languageModel - Provides information about the specified custom language model.
This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request
 wasn't successful, you can use this DescribeLanguageModel to help
 identify the reason for this failure.
$sel:httpStatus:DescribeLanguageModelResponse', describeLanguageModelResponse_httpStatus - The response's http status code.
GetCallAnalyticsCategory
data GetCallAnalyticsCategory Source #
See: newGetCallAnalyticsCategory smart constructor.
Constructors
| GetCallAnalyticsCategory' Text | 
Instances
newGetCallAnalyticsCategory Source #
Arguments
| :: Text | |
| -> GetCallAnalyticsCategory | 
Create a value of GetCallAnalyticsCategory 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:
GetCallAnalyticsCategory, getCallAnalyticsCategory_categoryName - The name of the Call Analytics category you want information about.
 Category names are case sensitive.
data GetCallAnalyticsCategoryResponse Source #
See: newGetCallAnalyticsCategoryResponse smart constructor.
Constructors
| GetCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int | 
Instances
newGetCallAnalyticsCategoryResponse Source #
Create a value of GetCallAnalyticsCategoryResponse 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:categoryProperties:GetCallAnalyticsCategoryResponse', getCallAnalyticsCategoryResponse_categoryProperties - Provides you with the properties of the Call Analytics category you
 specified in your GetCallAnalyticsCategory request.
$sel:httpStatus:GetCallAnalyticsCategoryResponse', getCallAnalyticsCategoryResponse_httpStatus - The response's http status code.
GetCallAnalyticsJob
data GetCallAnalyticsJob Source #
See: newGetCallAnalyticsJob smart constructor.
Constructors
| GetCallAnalyticsJob' Text | 
Instances
newGetCallAnalyticsJob Source #
Arguments
| :: Text | |
| -> GetCallAnalyticsJob | 
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.
data GetCallAnalyticsJobResponse Source #
See: newGetCallAnalyticsJobResponse smart constructor.
Constructors
| GetCallAnalyticsJobResponse' (Maybe CallAnalyticsJob) Int | 
Instances
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.
GetMedicalTranscriptionJob
data GetMedicalTranscriptionJob Source #
See: newGetMedicalTranscriptionJob smart constructor.
Constructors
| GetMedicalTranscriptionJob' Text | 
Instances
newGetMedicalTranscriptionJob Source #
Arguments
| :: Text | |
| -> GetMedicalTranscriptionJob | 
Create a value of GetMedicalTranscriptionJob 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:
GetMedicalTranscriptionJob, getMedicalTranscriptionJob_medicalTranscriptionJobName - The name of the medical transcription job you want information about.
 Job names are case sensitive.
data GetMedicalTranscriptionJobResponse Source #
See: newGetMedicalTranscriptionJobResponse smart constructor.
Constructors
| GetMedicalTranscriptionJobResponse' (Maybe MedicalTranscriptionJob) Int | 
Instances
newGetMedicalTranscriptionJobResponse Source #
Arguments
| :: Int | |
| -> GetMedicalTranscriptionJobResponse | 
Create a value of GetMedicalTranscriptionJobResponse 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:medicalTranscriptionJob:GetMedicalTranscriptionJobResponse', getMedicalTranscriptionJobResponse_medicalTranscriptionJob - Provides detailed information about the specified medical transcription
 job, including job status and, if applicable, failure reason.
$sel:httpStatus:GetMedicalTranscriptionJobResponse', getMedicalTranscriptionJobResponse_httpStatus - The response's http status code.
GetMedicalVocabulary
data GetMedicalVocabulary Source #
See: newGetMedicalVocabulary smart constructor.
Constructors
| GetMedicalVocabulary' Text | 
Instances
newGetMedicalVocabulary Source #
Arguments
| :: Text | |
| -> GetMedicalVocabulary | 
Create a value of GetMedicalVocabulary 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:
GetMedicalVocabulary, getMedicalVocabulary_vocabularyName - The name of the custom medical vocabulary you want information about.
 Custom medical vocabulary names are case sensitive.
data GetMedicalVocabularyResponse Source #
See: newGetMedicalVocabularyResponse smart constructor.
Constructors
| GetMedicalVocabularyResponse' (Maybe Text) (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int | 
Instances
newGetMedicalVocabularyResponse Source #
Create a value of GetMedicalVocabularyResponse 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:downloadUri:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_downloadUri - The S3 location where the specified custom medical vocabulary is stored;
 use this URI to view or download the custom vocabulary.
GetMedicalVocabularyResponse, getMedicalVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information
 about why the custom medical vocabulary request failed. See also:
 Common Errors.
GetMedicalVocabularyResponse, getMedicalVocabularyResponse_languageCode - The language code you selected for your custom medical vocabulary. US
 English (en-US) is the only language supported with Amazon Transcribe
 Medical.
GetMedicalVocabularyResponse, getMedicalVocabularyResponse_lastModifiedTime - The date and time the specified custom medical vocabulary was last
 modified.
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 12:32 PM UTC-7 on
 May 4, 2022.
GetMedicalVocabulary, getMedicalVocabularyResponse_vocabularyName - The name of the custom medical vocabulary you requested information
 about.
GetMedicalVocabularyResponse, getMedicalVocabularyResponse_vocabularyState - The processing state of your custom medical vocabulary. If the state is
 READY, you can use the custom vocabulary in a
 StartMedicalTranscriptionJob request.
$sel:httpStatus:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_httpStatus - The response's http status code.
GetTranscriptionJob
data GetTranscriptionJob Source #
See: newGetTranscriptionJob smart constructor.
Constructors
| GetTranscriptionJob' Text | 
Instances
newGetTranscriptionJob Source #
Arguments
| :: Text | |
| -> GetTranscriptionJob | 
Create a value of GetTranscriptionJob 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:
GetTranscriptionJob, getTranscriptionJob_transcriptionJobName - The name of the transcription job you want information about. Job names
 are case sensitive.
data GetTranscriptionJobResponse Source #
See: newGetTranscriptionJobResponse smart constructor.
Constructors
| GetTranscriptionJobResponse' (Maybe TranscriptionJob) Int | 
Instances
newGetTranscriptionJobResponse Source #
Create a value of GetTranscriptionJobResponse 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:transcriptionJob:GetTranscriptionJobResponse', getTranscriptionJobResponse_transcriptionJob - Provides detailed information about the specified transcription job,
 including job status and, if applicable, failure reason.
$sel:httpStatus:GetTranscriptionJobResponse', getTranscriptionJobResponse_httpStatus - The response's http status code.
GetVocabulary
data GetVocabulary Source #
See: newGetVocabulary smart constructor.
Constructors
| GetVocabulary' Text | 
Instances
Arguments
| :: Text | |
| -> GetVocabulary | 
Create a value of GetVocabulary 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:
GetVocabulary, getVocabulary_vocabularyName - The name of the custom vocabulary you want information about. Custom
 vocabulary names are case sensitive.
data GetVocabularyResponse Source #
See: newGetVocabularyResponse smart constructor.
Constructors
| GetVocabularyResponse' (Maybe Text) (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int | 
Instances
newGetVocabularyResponse Source #
Create a value of GetVocabularyResponse 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:downloadUri:GetVocabularyResponse', getVocabularyResponse_downloadUri - The S3 location where the custom vocabulary is stored; use this URI to
 view or download the custom vocabulary.
GetVocabularyResponse, getVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information
 about why the custom vocabulary request failed. See also:
 Common Errors.
GetVocabularyResponse, getVocabularyResponse_languageCode - The language code you selected for your custom vocabulary.
GetVocabularyResponse, getVocabularyResponse_lastModifiedTime - The date and time the specified custom vocabulary was last modified.
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 12:32 PM UTC-7 on
 May 4, 2022.
GetVocabulary, getVocabularyResponse_vocabularyName - The name of the custom vocabulary you requested information about.
GetVocabularyResponse, getVocabularyResponse_vocabularyState - The processing state of your custom vocabulary. If the state is READY,
 you can use the custom vocabulary in a StartTranscriptionJob request.
$sel:httpStatus:GetVocabularyResponse', getVocabularyResponse_httpStatus - The response's http status code.
GetVocabularyFilter
data GetVocabularyFilter Source #
See: newGetVocabularyFilter smart constructor.
Constructors
| GetVocabularyFilter' Text | 
Instances
newGetVocabularyFilter Source #
Arguments
| :: Text | |
| -> GetVocabularyFilter | 
Create a value of GetVocabularyFilter 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:
GetVocabularyFilter, getVocabularyFilter_vocabularyFilterName - The name of the custom vocabulary filter you want information about.
 Custom vocabulary filter names are case sensitive.
data GetVocabularyFilterResponse Source #
See: newGetVocabularyFilterResponse smart constructor.
Constructors
| GetVocabularyFilterResponse' (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int | 
Instances
newGetVocabularyFilterResponse Source #
Create a value of GetVocabularyFilterResponse 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:downloadUri:GetVocabularyFilterResponse', getVocabularyFilterResponse_downloadUri - The Amazon S3 location where the custom vocabulary filter is stored; use
 this URI to view or download the custom vocabulary filter.
GetVocabularyFilterResponse, getVocabularyFilterResponse_languageCode - The language code you selected for your custom vocabulary filter.
GetVocabularyFilterResponse, getVocabularyFilterResponse_lastModifiedTime - The date and time the specified custom vocabulary filter was last
 modified.
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 12:32 PM UTC-7 on
 May 4, 2022.
GetVocabularyFilter, getVocabularyFilterResponse_vocabularyFilterName - The name of the custom vocabulary filter you requested information
 about.
$sel:httpStatus:GetVocabularyFilterResponse', getVocabularyFilterResponse_httpStatus - The response's http status code.
ListCallAnalyticsCategories
data ListCallAnalyticsCategories Source #
See: newListCallAnalyticsCategories smart constructor.
Constructors
| ListCallAnalyticsCategories' (Maybe Natural) (Maybe Text) | 
Instances
newListCallAnalyticsCategories :: ListCallAnalyticsCategories Source #
Create a value of ListCallAnalyticsCategories 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:maxResults:ListCallAnalyticsCategories', listCallAnalyticsCategories_maxResults - The maximum number of Call Analytics categories to return in each page
 of results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
ListCallAnalyticsCategories, listCallAnalyticsCategories_nextToken - If your ListCallAnalyticsCategories request returns more results than
 can be displayed, NextToken is displayed in the response with an
 associated string. To get the next page of results, copy this string and
 repeat your request, including NextToken with the value of the copied
 string. Repeat as needed to view all your results.
data ListCallAnalyticsCategoriesResponse Source #
See: newListCallAnalyticsCategoriesResponse smart constructor.
Constructors
| ListCallAnalyticsCategoriesResponse' (Maybe [CategoryProperties]) (Maybe Text) Int | 
Instances
newListCallAnalyticsCategoriesResponse Source #
Arguments
| :: Int | |
| -> ListCallAnalyticsCategoriesResponse | 
Create a value of ListCallAnalyticsCategoriesResponse 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:categories:ListCallAnalyticsCategoriesResponse', listCallAnalyticsCategoriesResponse_categories - Provides detailed information about your Call Analytics categories,
 including all the rules associated with each category.
ListCallAnalyticsCategories, listCallAnalyticsCategoriesResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
$sel:httpStatus:ListCallAnalyticsCategoriesResponse', listCallAnalyticsCategoriesResponse_httpStatus - The response's http status code.
ListCallAnalyticsJobs
data ListCallAnalyticsJobs Source #
See: newListCallAnalyticsJobs smart constructor.
Constructors
| ListCallAnalyticsJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe CallAnalyticsJobStatus) | 
Instances
newListCallAnalyticsJobs :: ListCallAnalyticsJobs Source #
Create a value of ListCallAnalyticsJobs 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:jobNameContains:ListCallAnalyticsJobs', listCallAnalyticsJobs_jobNameContains - Returns only the Call Analytics jobs that contain the specified string.
 The search is not case sensitive.
$sel:maxResults:ListCallAnalyticsJobs', listCallAnalyticsJobs_maxResults - The maximum number of Call Analytics jobs to return in each page of
 results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
ListCallAnalyticsJobs, listCallAnalyticsJobs_nextToken - If your ListCallAnalyticsJobs request returns more results than can be
 displayed, NextToken is displayed in the response with an associated
 string. To get the next page of results, copy this string and repeat
 your request, including NextToken with the value of the copied string.
 Repeat as needed to view all your results.
ListCallAnalyticsJobs, listCallAnalyticsJobs_status - Returns only Call Analytics jobs with the specified status. Jobs are
 ordered by creation date, with the newest job first. If you don't
 include Status, all Call Analytics jobs are returned.
data ListCallAnalyticsJobsResponse Source #
See: newListCallAnalyticsJobsResponse smart constructor.
Constructors
| ListCallAnalyticsJobsResponse' (Maybe [CallAnalyticsJobSummary]) (Maybe Text) (Maybe CallAnalyticsJobStatus) Int | 
Instances
newListCallAnalyticsJobsResponse Source #
Create a value of ListCallAnalyticsJobsResponse 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:callAnalyticsJobSummaries:ListCallAnalyticsJobsResponse', listCallAnalyticsJobsResponse_callAnalyticsJobSummaries - Provides a summary of information about each result.
ListCallAnalyticsJobs, listCallAnalyticsJobsResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
ListCallAnalyticsJobs, listCallAnalyticsJobsResponse_status - Lists all Call Analytics jobs that have the status specified in your
 request. Jobs are ordered by creation date, with the newest job first.
$sel:httpStatus:ListCallAnalyticsJobsResponse', listCallAnalyticsJobsResponse_httpStatus - The response's http status code.
ListLanguageModels
data ListLanguageModels Source #
See: newListLanguageModels smart constructor.
Constructors
| ListLanguageModels' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe ModelStatus) | 
Instances
newListLanguageModels :: ListLanguageModels Source #
Create a value of ListLanguageModels 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:maxResults:ListLanguageModels', listLanguageModels_maxResults - The maximum number of custom language models to return in each page of
 results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
$sel:nameContains:ListLanguageModels', listLanguageModels_nameContains - Returns only the custom language models that contain the specified
 string. The search is not case sensitive.
ListLanguageModels, listLanguageModels_nextToken - If your ListLanguageModels request returns more results than can be
 displayed, NextToken is displayed in the response with an associated
 string. To get the next page of results, copy this string and repeat
 your request, including NextToken with the value of the copied string.
 Repeat as needed to view all your results.
$sel:statusEquals:ListLanguageModels', listLanguageModels_statusEquals - Returns only custom language models with the specified status. Language
 models are ordered by creation date, with the newest model first. If you
 don't include StatusEquals, all custom language models are returned.
data ListLanguageModelsResponse Source #
See: newListLanguageModelsResponse smart constructor.
Constructors
| ListLanguageModelsResponse' (Maybe [LanguageModel]) (Maybe Text) Int | 
Instances
newListLanguageModelsResponse Source #
Create a value of ListLanguageModelsResponse 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:models:ListLanguageModelsResponse', listLanguageModelsResponse_models - Provides information about the custom language models that match the
 criteria specified in your request.
ListLanguageModels, listLanguageModelsResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
$sel:httpStatus:ListLanguageModelsResponse', listLanguageModelsResponse_httpStatus - The response's http status code.
ListMedicalTranscriptionJobs
data ListMedicalTranscriptionJobs Source #
See: newListMedicalTranscriptionJobs smart constructor.
Constructors
| ListMedicalTranscriptionJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TranscriptionJobStatus) | 
Instances
newListMedicalTranscriptionJobs :: ListMedicalTranscriptionJobs Source #
Create a value of ListMedicalTranscriptionJobs 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:jobNameContains:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_jobNameContains - Returns only the medical transcription jobs that contain the specified
 string. The search is not case sensitive.
$sel:maxResults:ListMedicalTranscriptionJobs', listMedicalTranscriptionJobs_maxResults - The maximum number of medical transcription jobs to return in each page
 of results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
ListMedicalTranscriptionJobs, listMedicalTranscriptionJobs_nextToken - If your ListMedicalTranscriptionJobs request returns more results than
 can be displayed, NextToken is displayed in the response with an
 associated string. To get the next page of results, copy this string and
 repeat your request, including NextToken with the value of the copied
 string. Repeat as needed to view all your results.
ListMedicalTranscriptionJobs, listMedicalTranscriptionJobs_status - Returns only medical transcription jobs with the specified status. Jobs
 are ordered by creation date, with the newest job first. If you don't
 include Status, all medical transcription jobs are returned.
data ListMedicalTranscriptionJobsResponse Source #
See: newListMedicalTranscriptionJobsResponse smart constructor.
Constructors
| ListMedicalTranscriptionJobsResponse' (Maybe [MedicalTranscriptionJobSummary]) (Maybe Text) (Maybe TranscriptionJobStatus) Int | 
Instances
newListMedicalTranscriptionJobsResponse Source #
Arguments
| :: Int | |
| -> ListMedicalTranscriptionJobsResponse | 
Create a value of ListMedicalTranscriptionJobsResponse 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:medicalTranscriptionJobSummaries:ListMedicalTranscriptionJobsResponse', listMedicalTranscriptionJobsResponse_medicalTranscriptionJobSummaries - Provides a summary of information about each result.
ListMedicalTranscriptionJobs, listMedicalTranscriptionJobsResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
ListMedicalTranscriptionJobs, listMedicalTranscriptionJobsResponse_status - Lists all medical transcription jobs that have the status specified in
 your request. Jobs are ordered by creation date, with the newest job
 first.
$sel:httpStatus:ListMedicalTranscriptionJobsResponse', listMedicalTranscriptionJobsResponse_httpStatus - The response's http status code.
ListMedicalVocabularies
data ListMedicalVocabularies Source #
See: newListMedicalVocabularies smart constructor.
Constructors
| ListMedicalVocabularies' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe VocabularyState) | 
Instances
newListMedicalVocabularies :: ListMedicalVocabularies Source #
Create a value of ListMedicalVocabularies 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:maxResults:ListMedicalVocabularies', listMedicalVocabularies_maxResults - The maximum number of custom medical vocabularies to return in each page
 of results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
$sel:nameContains:ListMedicalVocabularies', listMedicalVocabularies_nameContains - Returns only the custom medical vocabularies that contain the specified
 string. The search is not case sensitive.
ListMedicalVocabularies, listMedicalVocabularies_nextToken - If your ListMedicalVocabularies request returns more results than can
 be displayed, NextToken is displayed in the response with an
 associated string. To get the next page of results, copy this string and
 repeat your request, including NextToken with the value of the copied
 string. Repeat as needed to view all your results.
$sel:stateEquals:ListMedicalVocabularies', listMedicalVocabularies_stateEquals - Returns only custom medical vocabularies with the specified state.
 Custom vocabularies are ordered by creation date, with the newest
 vocabulary first. If you don't include StateEquals, all custom
 medical vocabularies are returned.
data ListMedicalVocabulariesResponse Source #
See: newListMedicalVocabulariesResponse smart constructor.
Constructors
| ListMedicalVocabulariesResponse' (Maybe Text) (Maybe VocabularyState) (Maybe [VocabularyInfo]) Int | 
Instances
newListMedicalVocabulariesResponse Source #
Create a value of ListMedicalVocabulariesResponse 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:
ListMedicalVocabularies, listMedicalVocabulariesResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
$sel:status:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_status - Lists all custom medical vocabularies that have the status specified in
 your request. Custom vocabularies are ordered by creation date, with the
 newest vocabulary first.
$sel:vocabularies:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_vocabularies - Provides information about the custom medical vocabularies that match
 the criteria specified in your request.
$sel:httpStatus:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text | 
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource | 
Create a value of ListTagsForResource 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:
ListTagsForResource, listTagsForResource_resourceArn - Returns a list of all tags associated with the specified Amazon Resource
 Name (ARN). ARNs have the format
 arn:partition:service:region:account-id:resource-type/resource-id.
For example,
 arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,
 medical-transcription-job, vocabulary, medical-vocabulary,
 vocabulary-filter, and language-model.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResource, listTagsForResourceResponse_resourceArn - The Amazon Resource Name (ARN) specified in your request.
ListTagsForResourceResponse, listTagsForResourceResponse_tags - Lists all tags associated with the given transcription job, vocabulary,
 model, or resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListTranscriptionJobs
data ListTranscriptionJobs Source #
See: newListTranscriptionJobs smart constructor.
Constructors
| ListTranscriptionJobs' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe TranscriptionJobStatus) | 
Instances
newListTranscriptionJobs :: ListTranscriptionJobs Source #
Create a value of ListTranscriptionJobs 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:jobNameContains:ListTranscriptionJobs', listTranscriptionJobs_jobNameContains - Returns only the transcription jobs that contain the specified string.
 The search is not case sensitive.
$sel:maxResults:ListTranscriptionJobs', listTranscriptionJobs_maxResults - The maximum number of transcription jobs to return in each page of
 results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
ListTranscriptionJobs, listTranscriptionJobs_nextToken - If your ListTranscriptionJobs request returns more results than can be
 displayed, NextToken is displayed in the response with an associated
 string. To get the next page of results, copy this string and repeat
 your request, including NextToken with the value of the copied string.
 Repeat as needed to view all your results.
ListTranscriptionJobs, listTranscriptionJobs_status - Returns only transcription jobs with the specified status. Jobs are
 ordered by creation date, with the newest job first. If you don't
 include Status, all transcription jobs are returned.
data ListTranscriptionJobsResponse Source #
See: newListTranscriptionJobsResponse smart constructor.
Constructors
| ListTranscriptionJobsResponse' (Maybe Text) (Maybe TranscriptionJobStatus) (Maybe [TranscriptionJobSummary]) Int | 
Instances
newListTranscriptionJobsResponse Source #
Create a value of ListTranscriptionJobsResponse 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:
ListTranscriptionJobs, listTranscriptionJobsResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
ListTranscriptionJobs, listTranscriptionJobsResponse_status - Lists all transcription jobs that have the status specified in your
 request. Jobs are ordered by creation date, with the newest job first.
$sel:transcriptionJobSummaries:ListTranscriptionJobsResponse', listTranscriptionJobsResponse_transcriptionJobSummaries - Provides a summary of information about each result.
$sel:httpStatus:ListTranscriptionJobsResponse', listTranscriptionJobsResponse_httpStatus - The response's http status code.
ListVocabularies
data ListVocabularies Source #
See: newListVocabularies smart constructor.
Constructors
| ListVocabularies' (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe VocabularyState) | 
Instances
newListVocabularies :: ListVocabularies Source #
Create a value of ListVocabularies 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:maxResults:ListVocabularies', listVocabularies_maxResults - The maximum number of custom vocabularies to return in each page of
 results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
$sel:nameContains:ListVocabularies', listVocabularies_nameContains - Returns only the custom vocabularies that contain the specified string.
 The search is not case sensitive.
ListVocabularies, listVocabularies_nextToken - If your ListVocabularies request returns more results than can be
 displayed, NextToken is displayed in the response with an associated
 string. To get the next page of results, copy this string and repeat
 your request, including NextToken with the value of the copied string.
 Repeat as needed to view all your results.
$sel:stateEquals:ListVocabularies', listVocabularies_stateEquals - Returns only custom vocabularies with the specified state. Vocabularies
 are ordered by creation date, with the newest vocabulary first. If you
 don't include StateEquals, all custom medical vocabularies are
 returned.
data ListVocabulariesResponse Source #
See: newListVocabulariesResponse smart constructor.
Constructors
| ListVocabulariesResponse' (Maybe Text) (Maybe VocabularyState) (Maybe [VocabularyInfo]) Int | 
Instances
newListVocabulariesResponse Source #
Create a value of ListVocabulariesResponse 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:
ListVocabularies, listVocabulariesResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
$sel:status:ListVocabulariesResponse', listVocabulariesResponse_status - Lists all custom vocabularies that have the status specified in your
 request. Vocabularies are ordered by creation date, with the newest
 vocabulary first.
$sel:vocabularies:ListVocabulariesResponse', listVocabulariesResponse_vocabularies - Provides information about the custom vocabularies that match the
 criteria specified in your request.
$sel:httpStatus:ListVocabulariesResponse', listVocabulariesResponse_httpStatus - The response's http status code.
ListVocabularyFilters
data ListVocabularyFilters Source #
See: newListVocabularyFilters smart constructor.
Instances
newListVocabularyFilters :: ListVocabularyFilters Source #
Create a value of ListVocabularyFilters 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:maxResults:ListVocabularyFilters', listVocabularyFilters_maxResults - The maximum number of custom vocabulary filters to return in each page
 of results. If there are fewer results than the value that you specify,
 only the actual results are returned. If you don't specify a value, a
 default of 5 is used.
$sel:nameContains:ListVocabularyFilters', listVocabularyFilters_nameContains - Returns only the custom vocabulary filters that contain the specified
 string. The search is not case sensitive.
ListVocabularyFilters, listVocabularyFilters_nextToken - If your ListVocabularyFilters request returns more results than can be
 displayed, NextToken is displayed in the response with an associated
 string. To get the next page of results, copy this string and repeat
 your request, including NextToken with the value of the copied string.
 Repeat as needed to view all your results.
data ListVocabularyFiltersResponse Source #
See: newListVocabularyFiltersResponse smart constructor.
Constructors
| ListVocabularyFiltersResponse' (Maybe Text) (Maybe [VocabularyFilterInfo]) Int | 
Instances
newListVocabularyFiltersResponse Source #
Create a value of ListVocabularyFiltersResponse 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:
ListVocabularyFilters, listVocabularyFiltersResponse_nextToken - If NextToken is present in your response, it indicates that not all
 results are displayed. To view the next set of results, copy the string
 associated with the NextToken parameter in your results output, then
 run your request again including NextToken with the value of the
 copied string. Repeat as needed to view all your results.
$sel:vocabularyFilters:ListVocabularyFiltersResponse', listVocabularyFiltersResponse_vocabularyFilters - Provides information about the custom vocabulary filters that match the
 criteria specified in your request.
$sel:httpStatus:ListVocabularyFiltersResponse', listVocabularyFiltersResponse_httpStatus - The response's http status code.
StartCallAnalyticsJob
data StartCallAnalyticsJob Source #
See: newStartCallAnalyticsJob smart constructor.
Constructors
| StartCallAnalyticsJob' (Maybe (NonEmpty ChannelDefinition)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CallAnalyticsJobSettings) Text Media | 
Instances
newStartCallAnalyticsJob Source #
Arguments
| :: Text | |
| -> Media | |
| -> StartCallAnalyticsJob | 
Create a value of StartCallAnalyticsJob 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:
StartCallAnalyticsJob, startCallAnalyticsJob_channelDefinitions - Makes it possible to specify which speaker is on which channel. For
 example, if your agent is the first participant to speak, you would set
 ChannelId to 0 (to indicate the first channel) and ParticipantRole
 to AGENT (to indicate that it's the agent speaking).
StartCallAnalyticsJob, startCallAnalyticsJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to
 access the Amazon S3 bucket that contains your input files. If the role
 that you specify doesn’t have the appropriate permissions to access the
 specified Amazon S3 location, your request fails.
IAM role ARNs have the format
 arn:partition:iam::account:role/role-name-with-path. For example:
 arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
$sel:outputEncryptionKMSKeyId:StartCallAnalyticsJob', startCallAnalyticsJob_outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your Call Analytics output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
     
1234abcd-12ab-34cd-56ef-1234567890ab. - Use an alias for the KMS key ID. For example, 
alias/ExampleAlias. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
     
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
     
arn:aws:kms:region:account-ID:alias/ExampleAlias. 
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
     
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
     
arn:aws:kms:region:account-ID:alias/ExampleAlias. 
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify
 an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
$sel:outputLocation:StartCallAnalyticsJob', startCallAnalyticsJob_outputLocation - The Amazon S3 location where you want your Call Analytics transcription
 output stored. You can use any of the following formats to specify the
 output location:
- s3://DOC-EXAMPLE-BUCKET
 - s3://DOC-EXAMPLE-BUCKET/my-output-folder/
 - s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json
 
Unless you specify a file name (option 3), the name of your output file
 has a default value that matches the name you specified for your
 transcription job using the CallAnalyticsJobName parameter.
You can specify a KMS key to encrypt your output using the
 OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key,
 Amazon Transcribe uses the default Amazon S3 key for server-side
 encryption.
If you don't specify OutputLocation, your transcript is placed in a
 service-managed Amazon S3 bucket and you are provided with a URI to
 access your transcript.
StartCallAnalyticsJob, startCallAnalyticsJob_settings - Specify additional optional settings in your request, including content
 redaction; allows you to apply custom language models, vocabulary
 filters, and custom vocabularies to your Call Analytics job.
StartCallAnalyticsJob, startCallAnalyticsJob_callAnalyticsJobName - A unique name, chosen by you, for your Call Analytics job.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new job
 with the same name as an existing job, you get a ConflictException
 error.
StartCallAnalyticsJob, startCallAnalyticsJob_media - Describes the Amazon S3 location of the media file you want to use in
 your Call Analytics request.
data StartCallAnalyticsJobResponse Source #
See: newStartCallAnalyticsJobResponse smart constructor.
Constructors
| StartCallAnalyticsJobResponse' (Maybe CallAnalyticsJob) Int | 
Instances
newStartCallAnalyticsJobResponse Source #
Create a value of StartCallAnalyticsJobResponse 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:StartCallAnalyticsJobResponse', startCallAnalyticsJobResponse_callAnalyticsJob - Provides detailed information about the current Call Analytics job,
 including job status and, if applicable, failure reason.
$sel:httpStatus:StartCallAnalyticsJobResponse', startCallAnalyticsJobResponse_httpStatus - The response's http status code.
StartMedicalTranscriptionJob
data StartMedicalTranscriptionJob Source #
See: newStartMedicalTranscriptionJob smart constructor.
Constructors
Instances
newStartMedicalTranscriptionJob Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> Media | |
| -> Text | |
| -> Specialty | |
| -> Type | |
| -> StartMedicalTranscriptionJob | 
Create a value of StartMedicalTranscriptionJob 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:
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_contentIdentificationType - Labels all personal health information (PHI) identified in your
 transcript. For more information, see
 Identifying personal health information (PHI) in a transcription.
$sel:kmsEncryptionContext:StartMedicalTranscriptionJob', startMedicalTranscriptionJob_kmsEncryptionContext - A map of plain text, non-secret key:value pairs, known as encryption
 context pairs, that provide an added layer of security for your data.
 For more information, see
 KMS encryption context
 and
 Asymmetric keys in KMS.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_mediaFormat - Specify the format of your input media file.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe Medical
 determines it for you. If you specify the sample rate, it must match the
 rate detected by Amazon Transcribe Medical; if there's a mismatch
 between the value that you specify and the value detected, your job
 fails. Therefore, in most cases, it's advised to omit
 MediaSampleRateHertz and let Amazon Transcribe Medical determine the
 sample rate.
$sel:outputEncryptionKMSKeyId:StartMedicalTranscriptionJob', startMedicalTranscriptionJob_outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your medical transcription
 output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
     
1234abcd-12ab-34cd-56ef-1234567890ab. - Use an alias for the KMS key ID. For example, 
alias/ExampleAlias. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
     
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
     
arn:aws:kms:region:account-ID:alias/ExampleAlias. 
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
     
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
     
arn:aws:kms:region:account-ID:alias/ExampleAlias. 
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify
 an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
$sel:outputKey:StartMedicalTranscriptionJob', startMedicalTranscriptionJob_outputKey - Use in combination with OutputBucketName to specify the output
 location of your transcript and, optionally, a unique name for your
 output file. The default name for your transcription output is the same
 as the name you specified for your medical transcription job
 (MedicalTranscriptionJobName).
Here are some examples of how you can use OutputKey:
- If you specify 'DOC-EXAMPLE-BUCKET' as the 
OutputBucketNameand 'my-transcript.json' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript.json. - If you specify 'my-first-transcription' as the
     
MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName, and 'my-transcript' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. - If you specify 'DOC-EXAMPLE-BUCKET' as the 
OutputBucketNameand 'test-files/my-transcript.json' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. - If you specify 'my-first-transcription' as the
     
MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName, and 'test-files/my-transcript' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. 
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_settings - Specify additional optional settings in your request, including channel
 identification, alternative transcriptions, and speaker partitioning.
 You can use that to apply custom vocabularies to your transcription job.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
 new medical transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_medicalTranscriptionJobName - A unique name, chosen by you, for your medical transcription job. The
 name that you specify is also used as the default name of your
 transcription output file. If you want to specify a different name for
 your transcription output, use the OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new job
 with the same name as an existing job, you get a ConflictException
 error.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_languageCode - The language code that represents the language spoken in the input media
 file. US English (en-US) is the only valid value for medical
 transcription jobs. Any other value you enter for language code results
 in a BadRequestException error.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_media - Undocumented member.
$sel:outputBucketName:StartMedicalTranscriptionJob', startMedicalTranscriptionJob_outputBucketName - The name of the Amazon S3 bucket where you want your medical
 transcription output stored. Do not include the S3:// prefix of the
 specified bucket.
If you want your output to go to a sub-folder of this bucket, specify it
 using the OutputKey parameter; OutputBucketName only accepts the
 name of a bucket.
For example, if you want your output stored in
 S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to
 DOC-EXAMPLE-BUCKET. However, if you want your output stored in
 S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
 DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_specialty - Specify the predominant medical specialty represented in your media. For
 batch transcriptions, PRIMARYCARE is the only valid value. If you
 require additional specialties, refer to .
StartMedicalTranscriptionJob, startMedicalTranscriptionJob_type - Specify whether your input media contains only one person (DICTATION)
 or contains a conversation between two people (CONVERSATION).
For example, DICTATION could be used for a medical professional
 wanting to transcribe voice memos; CONVERSATION could be used for
 transcribing the doctor-patient dialogue during the patient's office
 visit.
data StartMedicalTranscriptionJobResponse Source #
See: newStartMedicalTranscriptionJobResponse smart constructor.
Constructors
| StartMedicalTranscriptionJobResponse' (Maybe MedicalTranscriptionJob) Int | 
Instances
newStartMedicalTranscriptionJobResponse Source #
Arguments
| :: Int | |
| -> StartMedicalTranscriptionJobResponse | 
Create a value of StartMedicalTranscriptionJobResponse 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:medicalTranscriptionJob:StartMedicalTranscriptionJobResponse', startMedicalTranscriptionJobResponse_medicalTranscriptionJob - Provides detailed information about the current medical transcription
 job, including job status and, if applicable, failure reason.
$sel:httpStatus:StartMedicalTranscriptionJobResponse', startMedicalTranscriptionJobResponse_httpStatus - The response's http status code.
StartTranscriptionJob
data StartTranscriptionJob Source #
See: newStartTranscriptionJob smart constructor.
Constructors
| StartTranscriptionJob' (Maybe ContentRedaction) (Maybe Bool) (Maybe Bool) (Maybe JobExecutionSettings) (Maybe (HashMap Text Text)) (Maybe LanguageCode) (Maybe (HashMap LanguageCode LanguageIdSettings)) (Maybe (NonEmpty LanguageCode)) (Maybe MediaFormat) (Maybe Natural) (Maybe ModelSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Settings) (Maybe Subtitles) (Maybe (NonEmpty Tag)) Text Media | 
Instances
newStartTranscriptionJob Source #
Arguments
| :: Text | |
| -> Media | |
| -> StartTranscriptionJob | 
Create a value of StartTranscriptionJob 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:
StartTranscriptionJob, startTranscriptionJob_contentRedaction - Makes it possible to redact or flag specified personally identifiable
 information (PII) in your transcript. If you use ContentRedaction, you
 must also include the sub-parameters: PiiEntityTypes,
 RedactionOutput, and RedactionType.
StartTranscriptionJob, startTranscriptionJob_identifyLanguage - Enables automatic language identification in your transcription job
 request. Use this parameter if your media file contains only one
 language. If your media contains multiple languages, use
 IdentifyMultipleLanguages instead.
If you include IdentifyLanguage, you can optionally include a list of
 language codes, using LanguageOptions, that you think may be present
 in your media file. Including LanguageOptions restricts
 IdentifyLanguage to only the language options that you specify, which
 can improve transcription accuracy.
If you want to apply a custom language model, a custom vocabulary, or a
 custom vocabulary filter to your automatic language identification
 request, include LanguageIdSettings with the relevant sub-parameters
 (VocabularyName, LanguageModelName, and VocabularyFilterName). If
 you include LanguageIdSettings, also include LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
 IdentifyMultipleLanguages in your request. If you include more than
 one of these parameters, your transcription job fails.
StartTranscriptionJob, startTranscriptionJob_identifyMultipleLanguages - Enables automatic multi-language identification in your transcription
 job request. Use this parameter if your media file contains more than
 one language. If your media contains only one language, use
 IdentifyLanguage instead.
If you include IdentifyMultipleLanguages, you can optionally include a
 list of language codes, using LanguageOptions, that you think may be
 present in your media file. Including LanguageOptions restricts
 IdentifyLanguage to only the language options that you specify, which
 can improve transcription accuracy.
If you want to apply a custom vocabulary or a custom vocabulary filter
 to your automatic language identification request, include
 LanguageIdSettings with the relevant sub-parameters (VocabularyName
 and VocabularyFilterName). If you include LanguageIdSettings, also
 include LanguageOptions.
Note that you must include one of LanguageCode, IdentifyLanguage, or
 IdentifyMultipleLanguages in your request. If you include more than
 one of these parameters, your transcription job fails.
StartTranscriptionJob, startTranscriptionJob_jobExecutionSettings - Makes it possible to control how your transcription job is processed.
 Currently, the only JobExecutionSettings modification you can choose
 is enabling job queueing using the AllowDeferredExecution
 sub-parameter.
If you include JobExecutionSettings in your request, you must also
 include the sub-parameters: AllowDeferredExecution and
 DataAccessRoleArn.
$sel:kmsEncryptionContext:StartTranscriptionJob', startTranscriptionJob_kmsEncryptionContext - A map of plain text, non-secret key:value pairs, known as encryption
 context pairs, that provide an added layer of security for your data.
 For more information, see
 KMS encryption context
 and
 Asymmetric keys in KMS.
StartTranscriptionJob, startTranscriptionJob_languageCode - The language code that represents the language spoken in the input media
 file.
If you're unsure of the language spoken in your media file, consider
 using IdentifyLanguage or IdentifyMultipleLanguages to enable
 automatic language identification.
Note that you must include one of LanguageCode, IdentifyLanguage, or
 IdentifyMultipleLanguages in your request. If you include more than
 one of these parameters, your transcription job fails.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media
 file must be encoded at a sample rate of 16,000 Hz or higher.
StartTranscriptionJob, startTranscriptionJob_languageIdSettings - If using automatic language identification in your request and you want
 to apply a custom language model, a custom vocabulary, or a custom
 vocabulary filter, include LanguageIdSettings with the relevant
 sub-parameters (VocabularyName, LanguageModelName, and
 VocabularyFilterName). Note that multi-language identification
 (IdentifyMultipleLanguages) doesn't support custom language models.
LanguageIdSettings supports two to five language codes. Each language
 code you include can have an associated custom language model, custom
 vocabulary, and custom vocabulary filter. The language codes that you
 specify must match the languages of the associated custom language
 models, custom vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions when using
 LanguageIdSettings to ensure that the correct language dialect is
 identified. For example, if you specify a custom vocabulary that is in
 en-US but Amazon Transcribe determines that the language spoken in
 your media is en-AU, your custom vocabulary is not applied to your
 transcription. If you include LanguageOptions and include en-US as
 the only English language dialect, your custom vocabulary is applied
 to your transcription.
If you want to include a custom language model with your request but
 do not want to use automatic language identification, use instead
 the parameter with the LanguageModelName sub-parameter. If you want to
 include a custom vocabulary or a custom vocabulary filter (or both) with
 your request but do not want to use automatic language
 identification, use instead the parameter with the VocabularyName or
 VocabularyFilterName (or both) sub-parameter.
StartTranscriptionJob, startTranscriptionJob_languageOptions - You can specify two or more language codes that represent the languages
 you think may be present in your media. Including more than five is not
 recommended. If you're unsure what languages are present, do not
 include this parameter.
If you include LanguageOptions in your request, you must also include
 IdentifyLanguage.
For more information, refer to Supported languages.
To transcribe speech in Modern Standard Arabic (ar-SA), your media
 file must be encoded at a sample rate of 16,000 Hz or higher.
StartTranscriptionJob, startTranscriptionJob_mediaFormat - Specify the format of your input media file.
StartTranscriptionJob, startTranscriptionJob_mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
If you don't specify the media sample rate, Amazon Transcribe
 determines it for you. If you specify the sample rate, it must match the
 rate detected by Amazon Transcribe. If there's a mismatch between the
 value that you specify and the value detected, your job fails. In most
 cases, you can omit MediaSampleRateHertz and let Amazon Transcribe
 determine the sample rate.
StartTranscriptionJob, startTranscriptionJob_modelSettings - Specify the custom language model you want to include with your
 transcription job. If you include ModelSettings in your request, you
 must include the LanguageModelName sub-parameter.
For more information, see Custom language models.
$sel:outputBucketName:StartTranscriptionJob', startTranscriptionJob_outputBucketName - The name of the Amazon S3 bucket where you want your transcription
 output stored. Do not include the S3:// prefix of the specified
 bucket.
If you want your output to go to a sub-folder of this bucket, specify it
 using the OutputKey parameter; OutputBucketName only accepts the
 name of a bucket.
For example, if you want your output stored in
 S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to
 DOC-EXAMPLE-BUCKET. However, if you want your output stored in
 S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
 DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
If you don't specify OutputBucketName, your transcript is placed in a
 service-managed Amazon S3 bucket and you are provided with a URI to
 access your transcript.
$sel:outputEncryptionKMSKeyId:StartTranscriptionJob', startTranscriptionJob_outputEncryptionKMSKeyId - The KMS key you want to use to encrypt your transcription output.
If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
- Use the KMS key ID itself. For example,
     
1234abcd-12ab-34cd-56ef-1234567890ab. - Use an alias for the KMS key ID. For example, 
alias/ExampleAlias. - Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
     
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
     
arn:aws:kms:region:account-ID:alias/ExampleAlias. 
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
- Use the ARN for the KMS key ID. For example,
     
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Use the ARN for the KMS key alias. For example,
     
arn:aws:kms:region:account-ID:alias/ExampleAlias. 
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).
If you specify a KMS key to encrypt your output, you must also specify
 an output location using the OutputLocation parameter.
Note that the user making the request must have permission to use the specified KMS key.
$sel:outputKey:StartTranscriptionJob', startTranscriptionJob_outputKey - Use in combination with OutputBucketName to specify the output
 location of your transcript and, optionally, a unique name for your
 output file. The default name for your transcription output is the same
 as the name you specified for your transcription job
 (TranscriptionJobName).
Here are some examples of how you can use OutputKey:
- If you specify 'DOC-EXAMPLE-BUCKET' as the 
OutputBucketNameand 'my-transcript.json' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript.json. - If you specify 'my-first-transcription' as the
     
TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName, and 'my-transcript' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json. - If you specify 'DOC-EXAMPLE-BUCKET' as the 
OutputBucketNameand 'test-files/my-transcript.json' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json. - If you specify 'my-first-transcription' as the
     
TranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as theOutputBucketName, and 'test-files/my-transcript' as theOutputKey, your transcription output path iss3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json. 
If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
StartTranscriptionJob, startTranscriptionJob_settings - Specify additional optional settings in your request, including channel
 identification, alternative transcriptions, speaker partitioning. You
 can use that to apply custom vocabularies and vocabulary filters.
If you want to include a custom vocabulary or a custom vocabulary filter
 (or both) with your request but do not want to use automatic
 language identification, use Settings with the VocabularyName or
 VocabularyFilterName (or both) sub-parameter.
If you're using automatic language identification with your request and
 want to include a custom language model, a custom vocabulary, or a
 custom vocabulary filter, use instead the parameter with the
 LanguageModelName, VocabularyName or VocabularyFilterName
 sub-parameters.
StartTranscriptionJob, startTranscriptionJob_subtitles - Produces subtitle files for your input media. You can specify WebVTT
 (*.vtt) and SubRip (*.srt) formats.
StartTranscriptionJob, startTranscriptionJob_tags - Adds one or more custom tags, each in the form of a key:value pair, to a
 new transcription job at the time you start this new job.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
StartTranscriptionJob, startTranscriptionJob_transcriptionJobName - A unique name, chosen by you, for your transcription job. The name that
 you specify is also used as the default name of your transcription
 output file. If you want to specify a different name for your
 transcription output, use the OutputKey parameter.
This name is case sensitive, cannot contain spaces, and must be unique
 within an Amazon Web Services account. If you try to create a new job
 with the same name as an existing job, you get a ConflictException
 error.
StartTranscriptionJob, startTranscriptionJob_media - Describes the Amazon S3 location of the media file you want to use in
 your request.
data StartTranscriptionJobResponse Source #
See: newStartTranscriptionJobResponse smart constructor.
Constructors
| StartTranscriptionJobResponse' (Maybe TranscriptionJob) Int | 
Instances
newStartTranscriptionJobResponse Source #
Create a value of StartTranscriptionJobResponse 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:transcriptionJob:StartTranscriptionJobResponse', startTranscriptionJobResponse_transcriptionJob - Provides detailed information about the current transcription job,
 including job status and, if applicable, failure reason.
$sel:httpStatus:StartTranscriptionJobResponse', startTranscriptionJobResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (NonEmpty Tag) | 
Instances
Arguments
| :: Text | |
| -> NonEmpty Tag | |
| -> TagResource | 
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the resource you want to tag. ARNs
 have the format
 arn:partition:service:region:account-id:resource-type/resource-id.
For example,
 arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,
 medical-transcription-job, vocabulary, medical-vocabulary,
 vocabulary-filter, and language-model.
TagResource, tagResource_tags - Adds one or more custom tags, each in the form of a key:value pair, to
 the specified resource.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int | 
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse | 
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) | 
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource | 
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
 want to remove tags from. ARNs have the format
 arn:partition:service:region:account-id:resource-type/resource-id.
For example,
 arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name.
Valid values for resource-type are: transcription-job,
 medical-transcription-job, vocabulary, medical-vocabulary,
 vocabulary-filter, and language-model.
$sel:tagKeys:UntagResource', untagResource_tagKeys - Removes the specified tag keys from the specified Amazon Transcribe
 resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int | 
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateCallAnalyticsCategory
data UpdateCallAnalyticsCategory Source #
See: newUpdateCallAnalyticsCategory smart constructor.
Instances
newUpdateCallAnalyticsCategory Source #
Arguments
| :: Text | |
| -> NonEmpty Rule | |
| -> UpdateCallAnalyticsCategory | 
Create a value of UpdateCallAnalyticsCategory 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:
UpdateCallAnalyticsCategory, updateCallAnalyticsCategory_inputType - Choose whether you want to update a streaming or a batch Call Analytics
 category. The input type you specify must match the input type specified
 when the category was created. For example, if you created a category
 with the POST_CALL input type, you must use POST_CALL as the input
 type when updating this category.
UpdateCallAnalyticsCategory, updateCallAnalyticsCategory_categoryName - The name of the Call Analytics category you want to update. Category
 names are case sensitive.
UpdateCallAnalyticsCategory, updateCallAnalyticsCategory_rules - The rules used for the updated Call Analytics category. The rules you
 provide in this field replace the ones that are currently being used in
 the specified category.
data UpdateCallAnalyticsCategoryResponse Source #
See: newUpdateCallAnalyticsCategoryResponse smart constructor.
Constructors
| UpdateCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int | 
Instances
newUpdateCallAnalyticsCategoryResponse Source #
Arguments
| :: Int | |
| -> UpdateCallAnalyticsCategoryResponse | 
Create a value of UpdateCallAnalyticsCategoryResponse 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:categoryProperties:UpdateCallAnalyticsCategoryResponse', updateCallAnalyticsCategoryResponse_categoryProperties - Provides you with the properties of the Call Analytics category you
 specified in your UpdateCallAnalyticsCategory request.
$sel:httpStatus:UpdateCallAnalyticsCategoryResponse', updateCallAnalyticsCategoryResponse_httpStatus - The response's http status code.
UpdateMedicalVocabulary
data UpdateMedicalVocabulary Source #
See: newUpdateMedicalVocabulary smart constructor.
Constructors
| UpdateMedicalVocabulary' Text LanguageCode Text | 
Instances
newUpdateMedicalVocabulary Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> Text | |
| -> UpdateMedicalVocabulary | 
Create a value of UpdateMedicalVocabulary 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:
UpdateMedicalVocabulary, updateMedicalVocabulary_vocabularyName - The name of the custom medical vocabulary you want to update. Custom
 medical vocabulary names are case sensitive.
UpdateMedicalVocabulary, updateMedicalVocabulary_languageCode - The language code that represents the language of the entries in the
 custom vocabulary you want to update. US English (en-US) is the only
 language supported with Amazon Transcribe Medical.
$sel:vocabularyFileUri:UpdateMedicalVocabulary', updateMedicalVocabulary_vocabularyFileUri - The Amazon S3 location of the text file that contains your custom
 medical vocabulary. The URI must be located in the same Amazon Web
 Services Region as the resource you're calling.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
data UpdateMedicalVocabularyResponse Source #
See: newUpdateMedicalVocabularyResponse smart constructor.
Constructors
| UpdateMedicalVocabularyResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int | 
Instances
newUpdateMedicalVocabularyResponse Source #
Create a value of UpdateMedicalVocabularyResponse 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:
UpdateMedicalVocabulary, updateMedicalVocabularyResponse_languageCode - The language code you selected for your custom medical vocabulary. US
 English (en-US) is the only language supported with Amazon Transcribe
 Medical.
UpdateMedicalVocabularyResponse, updateMedicalVocabularyResponse_lastModifiedTime - The date and time the specified custom medical vocabulary was last
 updated.
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 12:32 PM UTC-7 on
 May 4, 2022.
UpdateMedicalVocabulary, updateMedicalVocabularyResponse_vocabularyName - The name of the updated custom medical vocabulary.
UpdateMedicalVocabularyResponse, updateMedicalVocabularyResponse_vocabularyState - The processing state of your custom medical vocabulary. If the state is
 READY, you can use the custom vocabulary in a
 StartMedicalTranscriptionJob request.
$sel:httpStatus:UpdateMedicalVocabularyResponse', updateMedicalVocabularyResponse_httpStatus - The response's http status code.
UpdateVocabulary
data UpdateVocabulary Source #
See: newUpdateVocabulary smart constructor.
Constructors
| UpdateVocabulary' (Maybe [Text]) (Maybe Text) Text LanguageCode | 
Instances
Arguments
| :: Text | |
| -> LanguageCode | |
| -> UpdateVocabulary | 
Create a value of UpdateVocabulary 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:phrases:UpdateVocabulary', updateVocabulary_phrases - Use this parameter if you want to update your custom vocabulary by
 including all desired terms, as comma-separated values, within your
 request. The other option for updating your custom vocabulary is to save
 your entries in a text file and upload them to an Amazon S3 bucket, then
 specify the location of your file using the VocabularyFileUri
 parameter.
Note that if you include Phrases in your request, you cannot use
 VocabularyFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
$sel:vocabularyFileUri:UpdateVocabulary', updateVocabulary_vocabularyFileUri - The Amazon S3 location of the text file that contains your custom
 vocabulary. The URI must be located in the same Amazon Web Services
 Region as the resource you're calling.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt
Note that if you include VocabularyFileUri in your request, you cannot
 use the Phrases flag; you must choose one or the other.
UpdateVocabulary, updateVocabulary_vocabularyName - The name of the custom vocabulary you want to update. Custom vocabulary
 names are case sensitive.
UpdateVocabulary, updateVocabulary_languageCode - The language code that represents the language of the entries in the
 custom vocabulary you want to update. Each custom vocabulary must
 contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same
 language as the custom vocabulary. For example, if you create a custom
 vocabulary using US English (en-US), you can only apply this custom
 vocabulary to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
data UpdateVocabularyResponse Source #
See: newUpdateVocabularyResponse smart constructor.
Constructors
| UpdateVocabularyResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) Int | 
Instances
newUpdateVocabularyResponse Source #
Create a value of UpdateVocabularyResponse 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:
UpdateVocabulary, updateVocabularyResponse_languageCode - The language code you selected for your custom vocabulary.
UpdateVocabularyResponse, updateVocabularyResponse_lastModifiedTime - The date and time the specified custom vocabulary was last updated.
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 12:32 PM UTC-7 on
 May 4, 2022.
UpdateVocabulary, updateVocabularyResponse_vocabularyName - The name of the updated custom vocabulary.
UpdateVocabularyResponse, updateVocabularyResponse_vocabularyState - The processing state of your custom vocabulary. If the state is READY,
 you can use the custom vocabulary in a StartTranscriptionJob request.
$sel:httpStatus:UpdateVocabularyResponse', updateVocabularyResponse_httpStatus - The response's http status code.
UpdateVocabularyFilter
data UpdateVocabularyFilter Source #
See: newUpdateVocabularyFilter smart constructor.
Instances
newUpdateVocabularyFilter Source #
Arguments
| :: Text | |
| -> UpdateVocabularyFilter | 
Create a value of UpdateVocabularyFilter 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:vocabularyFilterFileUri:UpdateVocabularyFilter', updateVocabularyFilter_vocabularyFilterFileUri - The Amazon S3 location of the text file that contains your custom
 vocabulary filter terms. The URI must be located in the same Amazon Web
 Services Region as the resource you're calling.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you
 cannot use Words; you must choose one or the other.
$sel:words:UpdateVocabularyFilter', updateVocabularyFilter_words - Use this parameter if you want to update your custom vocabulary filter
 by including all desired terms, as comma-separated values, within your
 request. The other option for updating your vocabulary filter is to save
 your entries in a text file and upload them to an Amazon S3 bucket, then
 specify the location of your file using the VocabularyFilterFileUri
 parameter.
Note that if you include Words in your request, you cannot use
 VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
UpdateVocabularyFilter, updateVocabularyFilter_vocabularyFilterName - The name of the custom vocabulary filter you want to update. Custom
 vocabulary filter names are case sensitive.
data UpdateVocabularyFilterResponse Source #
See: newUpdateVocabularyFilterResponse smart constructor.
Constructors
| UpdateVocabularyFilterResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int | 
Instances
newUpdateVocabularyFilterResponse Source #
Create a value of UpdateVocabularyFilterResponse 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:
UpdateVocabularyFilterResponse, updateVocabularyFilterResponse_languageCode - The language code you selected for your custom vocabulary filter.
UpdateVocabularyFilterResponse, updateVocabularyFilterResponse_lastModifiedTime - The date and time the specified custom vocabulary filter was last
 updated.
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 12:32 PM UTC-7 on
 May 4, 2022.
UpdateVocabularyFilter, updateVocabularyFilterResponse_vocabularyFilterName - The name of the updated custom vocabulary filter.
$sel:httpStatus:UpdateVocabularyFilterResponse', updateVocabularyFilterResponse_httpStatus - The response's http status code.
Types
BaseModelName
newtype BaseModelName Source #
Constructors
| BaseModelName' | |
Fields  | |
Bundled Patterns
| pattern BaseModelName_NarrowBand :: BaseModelName | |
| pattern BaseModelName_WideBand :: BaseModelName | 
Instances
CLMLanguageCode
newtype CLMLanguageCode Source #
Constructors
| CLMLanguageCode' | |
Fields  | |
Bundled Patterns
| pattern CLMLanguageCode_De_DE :: CLMLanguageCode | |
| pattern CLMLanguageCode_En_AU :: CLMLanguageCode | |
| pattern CLMLanguageCode_En_GB :: CLMLanguageCode | |
| pattern CLMLanguageCode_En_US :: CLMLanguageCode | |
| pattern CLMLanguageCode_Es_US :: CLMLanguageCode | |
| pattern CLMLanguageCode_Hi_IN :: CLMLanguageCode | |
| pattern CLMLanguageCode_Ja_JP :: CLMLanguageCode | 
Instances
CallAnalyticsJobStatus
newtype CallAnalyticsJobStatus Source #
Constructors
| CallAnalyticsJobStatus' | |
Fields  | |
Bundled Patterns
Instances
InputType
Constructors
| InputType' | |
Fields  | |
Bundled Patterns
| pattern InputType_POST_CALL :: InputType | |
| pattern InputType_REAL_TIME :: InputType | 
Instances
LanguageCode
newtype LanguageCode Source #
Constructors
| LanguageCode' | |
Fields  | |
Bundled Patterns
Instances
MediaFormat
newtype MediaFormat Source #
Constructors
| MediaFormat' | |
Fields  | |
Bundled Patterns
| pattern MediaFormat_Amr :: MediaFormat | |
| pattern MediaFormat_Flac :: MediaFormat | |
| pattern MediaFormat_Mp3 :: MediaFormat | |
| pattern MediaFormat_Mp4 :: MediaFormat | |
| pattern MediaFormat_Ogg :: MediaFormat | |
| pattern MediaFormat_Wav :: MediaFormat | |
| pattern MediaFormat_Webm :: MediaFormat | 
Instances
MedicalContentIdentificationType
newtype MedicalContentIdentificationType Source #
Constructors
| MedicalContentIdentificationType' | |
Fields  | |
Bundled Patterns
| pattern MedicalContentIdentificationType_PHI :: MedicalContentIdentificationType | 
Instances
ModelStatus
newtype ModelStatus Source #
Constructors
| ModelStatus' | |
Fields  | |
Bundled Patterns
| pattern ModelStatus_COMPLETED :: ModelStatus | |
| pattern ModelStatus_FAILED :: ModelStatus | |
| pattern ModelStatus_IN_PROGRESS :: ModelStatus | 
Instances
OutputLocationType
newtype OutputLocationType Source #
Constructors
| OutputLocationType' | |
Fields  | |
Bundled Patterns
| pattern OutputLocationType_CUSTOMER_BUCKET :: OutputLocationType | |
| pattern OutputLocationType_SERVICE_BUCKET :: OutputLocationType | 
Instances
ParticipantRole
newtype ParticipantRole Source #
Constructors
| ParticipantRole' | |
Fields  | |
Bundled Patterns
| pattern ParticipantRole_AGENT :: ParticipantRole | |
| pattern ParticipantRole_CUSTOMER :: ParticipantRole | 
Instances
PiiEntityType
newtype PiiEntityType Source #
Constructors
| PiiEntityType' | |
Fields  | |
Bundled Patterns
| pattern PiiEntityType_ADDRESS :: PiiEntityType | |
| pattern PiiEntityType_ALL :: PiiEntityType | |
| pattern PiiEntityType_BANK_ACCOUNT_NUMBER :: PiiEntityType | |
| pattern PiiEntityType_BANK_ROUTING :: PiiEntityType | |
| pattern PiiEntityType_CREDIT_DEBIT_CVV :: PiiEntityType | |
| pattern PiiEntityType_CREDIT_DEBIT_EXPIRY :: PiiEntityType | |
| pattern PiiEntityType_CREDIT_DEBIT_NUMBER :: PiiEntityType | |
| pattern PiiEntityType_EMAIL :: PiiEntityType | |
| pattern PiiEntityType_NAME :: PiiEntityType | |
| pattern PiiEntityType_PHONE :: PiiEntityType | |
| pattern PiiEntityType_PIN :: PiiEntityType | |
| pattern PiiEntityType_SSN :: PiiEntityType | 
Instances
RedactionOutput
newtype RedactionOutput Source #
Constructors
| RedactionOutput' | |
Fields  | |
Bundled Patterns
| pattern RedactionOutput_Redacted :: RedactionOutput | |
| pattern RedactionOutput_Redacted_and_unredacted :: RedactionOutput | 
Instances
RedactionType
newtype RedactionType Source #
Constructors
| RedactionType' | |
Fields  | |
Bundled Patterns
| pattern RedactionType_PII :: RedactionType | 
Instances
SentimentValue
newtype SentimentValue Source #
Constructors
| SentimentValue' | |
Fields  | |
Bundled Patterns
| pattern SentimentValue_MIXED :: SentimentValue | |
| pattern SentimentValue_NEGATIVE :: SentimentValue | |
| pattern SentimentValue_NEUTRAL :: SentimentValue | |
| pattern SentimentValue_POSITIVE :: SentimentValue | 
Instances
Specialty
Constructors
| Specialty' | |
Fields  | |
Bundled Patterns
| pattern Specialty_PRIMARYCARE :: Specialty | 
Instances
SubtitleFormat
newtype SubtitleFormat Source #
Constructors
| SubtitleFormat' | |
Fields  | |
Bundled Patterns
| pattern SubtitleFormat_Srt :: SubtitleFormat | |
| pattern SubtitleFormat_Vtt :: SubtitleFormat | 
Instances
TranscriptFilterType
newtype TranscriptFilterType Source #
Constructors
| TranscriptFilterType' | |
Fields  | |
Bundled Patterns
| pattern TranscriptFilterType_EXACT :: TranscriptFilterType | 
Instances
TranscriptionJobStatus
newtype TranscriptionJobStatus Source #
Constructors
| TranscriptionJobStatus' | |
Fields  | |
Bundled Patterns
Instances
Type
Bundled Patterns
| pattern Type_CONVERSATION :: Type | |
| pattern Type_DICTATION :: Type | 
Instances
VocabularyFilterMethod
newtype VocabularyFilterMethod Source #
Constructors
| VocabularyFilterMethod' | |
Fields  | |
Bundled Patterns
| pattern VocabularyFilterMethod_Mask :: VocabularyFilterMethod | |
| pattern VocabularyFilterMethod_Remove :: VocabularyFilterMethod | |
| pattern VocabularyFilterMethod_Tag :: VocabularyFilterMethod | 
Instances
VocabularyState
newtype VocabularyState Source #
Constructors
| VocabularyState' | |
Fields  | |
Bundled Patterns
| pattern VocabularyState_FAILED :: VocabularyState | |
| pattern VocabularyState_PENDING :: VocabularyState | |
| pattern VocabularyState_READY :: VocabularyState | 
Instances
AbsoluteTimeRange
data AbsoluteTimeRange Source #
A time range, in milliseconds, between two points in your media file.
You can use StartTime and EndTime to search a custom segment. For
 example, setting StartTime to 10000 and EndTime to 50000 only
 searches for your specified criteria in the audio contained between the
 10,000 millisecond mark and the 50,000 millisecond mark of your media
 file. You must use StartTime and EndTime as a set; that is, if you
 include one, you must include both.
You can use also First to search from the start of the audio until the
 time that you specify, or Last to search from the time that you
 specify until the end of the audio. For example, setting First to
 50000 only searches for your specified criteria in the audio contained
 between the start of the media file to the 50,000 millisecond mark. You
 can use First and Last independently of each other.
If you prefer to use percentage instead of milliseconds, see .
See: newAbsoluteTimeRange smart constructor.
Instances
newAbsoluteTimeRange :: AbsoluteTimeRange Source #
Create a value of AbsoluteTimeRange 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:endTime:AbsoluteTimeRange', absoluteTimeRange_endTime - The time, in milliseconds, when Amazon Transcribe stops searching for
 the specified criteria in your audio. If you include EndTime in your
 request, you must also include StartTime.
$sel:first:AbsoluteTimeRange', absoluteTimeRange_first - The time, in milliseconds, from the start of your media file until the
 specified value. Amazon Transcribe searches for your specified criteria
 in this time segment.
$sel:last:AbsoluteTimeRange', absoluteTimeRange_last - The time, in milliseconds, from the specified value until the end of
 your media file. Amazon Transcribe searches for your specified criteria
 in this time segment.
$sel:startTime:AbsoluteTimeRange', absoluteTimeRange_startTime - The time, in milliseconds, when Amazon Transcribe starts searching for
 the specified criteria in your audio. If you include StartTime in your
 request, you must also include EndTime.
CallAnalyticsJob
data CallAnalyticsJob Source #
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' (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe (NonEmpty ChannelDefinition)) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe LanguageCode) (Maybe Media) (Maybe MediaFormat) (Maybe Natural) (Maybe CallAnalyticsJobSettings) (Maybe POSIX) (Maybe Transcript) | 
Instances
newCallAnalyticsJob :: CallAnalyticsJob Source #
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
MediaFormatisn'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
MediaFormatdoesn'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
MediaSampleRateHertzisn'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
MediaSampleRateHertzdoesn'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.
CallAnalyticsJobSettings
data CallAnalyticsJobSettings Source #
Provides additional optional settings for your request, including content redaction, automatic language identification; allows you to apply custom language models, custom vocabulary filters, and custom vocabularies.
See: newCallAnalyticsJobSettings smart constructor.
Constructors
Instances
newCallAnalyticsJobSettings :: CallAnalyticsJobSettings Source #
Create a value of CallAnalyticsJobSettings 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:contentRedaction:CallAnalyticsJobSettings', callAnalyticsJobSettings_contentRedaction - Undocumented member.
$sel:languageIdSettings:CallAnalyticsJobSettings', callAnalyticsJobSettings_languageIdSettings - If using automatic language identification in your request and you want
 to apply a custom language model, a custom vocabulary, or a custom
 vocabulary filter, include LanguageIdSettings with the relevant
 sub-parameters (VocabularyName, LanguageModelName, and
 VocabularyFilterName).
LanguageIdSettings supports two to five language codes. Each language
 code you include can have an associated custom language model, custom
 vocabulary, and custom vocabulary filter. The language codes that you
 specify must match the languages of the associated custom language
 models, custom vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions when using
 LanguageIdSettings to ensure that the correct language dialect is
 identified. For example, if you specify a custom vocabulary that is in
 en-US but Amazon Transcribe determines that the language spoken in
 your media is en-AU, your custom vocabulary is not applied to your
 transcription. If you include LanguageOptions and include en-US as
 the only English language dialect, your custom vocabulary is applied
 to your transcription.
If you want to include a custom language model, custom vocabulary, or
 custom vocabulary filter with your request but do not want to use
 automatic language identification, use instead the parameter with the
 LanguageModelName, VocabularyName, or VocabularyFilterName
 sub-parameters.
For a list of languages supported with Call Analytics, refer to Supported languages and language-specific features.
CallAnalyticsJobSettings, callAnalyticsJobSettings_languageModelName - The name of the custom language model you want to use when processing
 your Call Analytics job. Note that custom language model names are case
 sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
$sel:languageOptions:CallAnalyticsJobSettings', callAnalyticsJobSettings_languageOptions - You can specify two or more language codes that represent the languages
 you think may be present in your media. Including more than five is not
 recommended. If you're unsure what languages are present, do not
 include this parameter.
Including language options can improve the accuracy of language identification.
For a list of languages supported with Call Analytics, refer to the Supported languages table.
To transcribe speech in Modern Standard Arabic (ar-SA), your media
 file must be encoded at a sample rate of 16,000 Hz or higher.
$sel:vocabularyFilterMethod:CallAnalyticsJobSettings', callAnalyticsJobSettings_vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your
 transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
CallAnalyticsJobSettings, callAnalyticsJobSettings_vocabularyFilterName - The name of the custom vocabulary filter you want to include in your
 Call Analytics transcription request. Custom vocabulary filter names are
 case sensitive.
Note that if you include VocabularyFilterName in your request, you
 must also include VocabularyFilterMethod.
CallAnalyticsJobSettings, callAnalyticsJobSettings_vocabularyName - The name of the custom vocabulary you want to include in your Call
 Analytics transcription request. Custom vocabulary names are case
 sensitive.
CallAnalyticsJobSummary
data CallAnalyticsJobSummary Source #
Provides detailed information about a specific Call Analytics job.
See: newCallAnalyticsJobSummary smart constructor.
Constructors
| CallAnalyticsJobSummary' (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe LanguageCode) (Maybe POSIX) | 
Instances
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.
CategoryProperties
data CategoryProperties Source #
Provides you with the properties of the Call Analytics category you specified in your request. This includes the list of rules that define the specified category.
See: newCategoryProperties smart constructor.
Constructors
| CategoryProperties' (Maybe Text) (Maybe POSIX) (Maybe InputType) (Maybe POSIX) (Maybe (NonEmpty Rule)) | 
Instances
newCategoryProperties :: CategoryProperties Source #
Create a value of CategoryProperties 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:categoryName:CategoryProperties', categoryProperties_categoryName - The name of the Call Analytics category. Category names are case
 sensitive and must be unique within an Amazon Web Services account.
$sel:createTime:CategoryProperties', categoryProperties_createTime - The date and time the specified Call Analytics category was created.
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 12:32 PM UTC-7 on
 May 4, 2022.
$sel:inputType:CategoryProperties', categoryProperties_inputType - The input type associated with the specified category. POST_CALL
 refers to a category that is applied to batch transcriptions;
 REAL_TIME refers to a category that is applied to streaming
 transcriptions.
$sel:lastUpdateTime:CategoryProperties', categoryProperties_lastUpdateTime - The date and time the specified Call Analytics category was last
 updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For
 example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on
 May 5, 2022.
$sel:rules:CategoryProperties', categoryProperties_rules - The rules used to define a Call Analytics category. Each category can
 have between 1 and 20 rules.
ChannelDefinition
data ChannelDefinition Source #
Makes it possible to specify which speaker is on which channel. For
 example, if your agent is the first participant to speak, you would set
 ChannelId to 0 (to indicate the first channel) and ParticipantRole
 to AGENT (to indicate that it's the agent speaking).
See: newChannelDefinition smart constructor.
Constructors
| ChannelDefinition' (Maybe Natural) (Maybe ParticipantRole) | 
Instances
newChannelDefinition :: ChannelDefinition Source #
Create a value of ChannelDefinition 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:channelId:ChannelDefinition', channelDefinition_channelId - Specify the audio channel you want to define.
$sel:participantRole:ChannelDefinition', channelDefinition_participantRole - Specify the speaker you want to define. Omitting this parameter is
 equivalent to specifying both participants.
ContentRedaction
data ContentRedaction Source #
Makes it possible to redact or flag specified personally identifiable
 information (PII) in your transcript. If you use ContentRedaction, you
 must also include the sub-parameters: PiiEntityTypes,
 RedactionOutput, and RedactionType.
See: newContentRedaction smart constructor.
Constructors
| ContentRedaction' (Maybe [PiiEntityType]) RedactionType RedactionOutput | 
Instances
Arguments
| :: RedactionType | |
| -> RedactionOutput | |
| -> ContentRedaction | 
Create a value of ContentRedaction 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:piiEntityTypes:ContentRedaction', contentRedaction_piiEntityTypes - Specify which types of personally identifiable information (PII) you
 want to redact in your transcript. You can include as many types as
 you'd like, or you can select ALL.
$sel:redactionType:ContentRedaction', contentRedaction_redactionType - Specify the category of information you want to redact; PII
 (personally identifiable information) is the only valid value. You can
 use PiiEntityTypes to choose which types of PII you want to redact.
$sel:redactionOutput:ContentRedaction', contentRedaction_redactionOutput - Specify if you want only a redacted transcript, or if you want a
 redacted and an unredacted transcript.
When you choose redacted Amazon Transcribe creates only a redacted
 transcript.
When you choose redacted_and_unredacted Amazon Transcribe creates a
 redacted and an unredacted transcript (as two separate files).
InputDataConfig
data InputDataConfig Source #
Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.
When using InputDataConfig, you must include these sub-parameters:
 S3Uri and DataAccessRoleArn. You can optionally include
 TuningDataS3Uri.
See: newInputDataConfig smart constructor.
Constructors
| InputDataConfig' (Maybe Text) Text Text | 
Instances
Arguments
| :: Text | |
| -> Text | |
| -> InputDataConfig | 
Create a value of InputDataConfig 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:tuningDataS3Uri:InputDataConfig', inputDataConfig_tuningDataS3Uri - The Amazon S3 location (URI) of the text files you want to use to tune
 your custom language model.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/
$sel:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The Amazon S3 location (URI) of the text files you want to use to train
 your custom language model.
Here's an example URI path:
 s3://DOC-EXAMPLE-BUCKET/my-model-training-data/
$sel:dataAccessRoleArn:InputDataConfig', inputDataConfig_dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to
 access the Amazon S3 bucket that contains your input files. If the role
 that you specify doesn’t have the appropriate permissions to access the
 specified Amazon S3 location, your request fails.
IAM role ARNs have the format
 arn:partition:iam::account:role/role-name-with-path. For example:
 arn:aws:iam::111122223333:role/Admin.
For more information, see IAM ARNs.
InterruptionFilter
data InterruptionFilter Source #
Flag the presence or absence of interruptions in your Call Analytics transcription output.
Rules using InterruptionFilter are designed to match:
- Instances where an agent interrupts a customer
 - Instances where a customer interrupts an agent
 - Either participant interrupting the other
 - A lack of interruptions
 
See Rule criteria for batch categories for usage examples.
See: newInterruptionFilter smart constructor.
Constructors
| InterruptionFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Natural) | 
Instances
newInterruptionFilter :: InterruptionFilter Source #
Create a value of InterruptionFilter 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:absoluteTimeRange:InterruptionFilter', interruptionFilter_absoluteTimeRange - Makes it possible to specify a time range (in milliseconds) in your
 audio, during which you want to search for an interruption. See for more
 detail.
$sel:negate:InterruptionFilter', interruptionFilter_negate - Set to TRUE to flag speech that does not contain interruptions. Set to
 FALSE to flag speech that contains interruptions.
$sel:participantRole:InterruptionFilter', interruptionFilter_participantRole - Specify the interrupter that you want to flag. Omitting this parameter
 is equivalent to specifying both participants.
$sel:relativeTimeRange:InterruptionFilter', interruptionFilter_relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media
 file, during which you want to search for an interruption. See for more
 detail.
$sel:threshold:InterruptionFilter', interruptionFilter_threshold - Specify the duration of the interruptions in milliseconds. For example,
 you can flag speech that contains more than 10,000 milliseconds of
 interruptions.
JobExecutionSettings
data JobExecutionSettings Source #
Makes it possible to control how your transcription job is processed.
 Currently, the only JobExecutionSettings modification you can choose
 is enabling job queueing using the AllowDeferredExecution
 sub-parameter.
If you include JobExecutionSettings in your request, you must also
 include the sub-parameters: AllowDeferredExecution and
 DataAccessRoleArn.
See: newJobExecutionSettings smart constructor.
Constructors
| JobExecutionSettings' (Maybe Bool) (Maybe Text) | 
Instances
newJobExecutionSettings :: JobExecutionSettings Source #
Create a value of JobExecutionSettings 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:allowDeferredExecution:JobExecutionSettings', jobExecutionSettings_allowDeferredExecution - Makes it possible to enable job queuing when your concurrent request
 limit is exceeded. When AllowDeferredExecution is set to true,
 transcription job requests are placed in a queue until the number of
 jobs falls below the concurrent request limit. If
 AllowDeferredExecution is set to false and the number of
 transcription job requests exceed the concurrent request limit, you get
 a LimitExceededException error.
Note that job queuing is enabled by default for Call Analytics jobs.
If you include AllowDeferredExecution in your request, you must also
 include DataAccessRoleArn.
$sel:dataAccessRoleArn:JobExecutionSettings', jobExecutionSettings_dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to
 access the Amazon S3 bucket that contains your input files. If the role
 that you specify doesn’t have the appropriate permissions to access the
 specified Amazon S3 location, your request fails.
IAM role ARNs have the format
 arn:partition:iam::account:role/role-name-with-path. For example:
 arn:aws:iam::111122223333:role/Admin. For more information, see
 IAM ARNs.
Note that if you include DataAccessRoleArn in your request, you must
 also include AllowDeferredExecution.
LanguageCodeItem
data LanguageCodeItem Source #
Provides information on the speech contained in a discreet utterance when multi-language identification is enabled in your request. This utterance represents a block of speech consisting of one language, preceded or followed by a block of speech in a different language.
See: newLanguageCodeItem smart constructor.
Constructors
| LanguageCodeItem' (Maybe Double) (Maybe LanguageCode) | 
Instances
newLanguageCodeItem :: LanguageCodeItem Source #
Create a value of LanguageCodeItem 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:durationInSeconds:LanguageCodeItem', languageCodeItem_durationInSeconds - Provides the total time, in seconds, each identified language is spoken
 in your media.
$sel:languageCode:LanguageCodeItem', languageCodeItem_languageCode - Provides the language code for each language identified in your media.
LanguageIdSettings
data LanguageIdSettings Source #
If using automatic language identification in your request and you want
 to apply a custom language model, a custom vocabulary, or a custom
 vocabulary filter, include LanguageIdSettings with the relevant
 sub-parameters (VocabularyName, LanguageModelName, and
 VocabularyFilterName). Note that multi-language identification
 (IdentifyMultipleLanguages) doesn't support custom language models.
LanguageIdSettings supports two to five language codes. Each language
 code you include can have an associated custom language model, custom
 vocabulary, and custom vocabulary filter. The language codes that you
 specify must match the languages of the associated custom language
 models, custom vocabularies, and custom vocabulary filters.
It's recommended that you include LanguageOptions when using
 LanguageIdSettings to ensure that the correct language dialect is
 identified. For example, if you specify a custom vocabulary that is in
 en-US but Amazon Transcribe determines that the language spoken in
 your media is en-AU, your custom vocabulary is not applied to your
 transcription. If you include LanguageOptions and include en-US as
 the only English language dialect, your custom vocabulary is applied
 to your transcription.
If you want to include a custom language model with your request but
 do not want to use automatic language identification, use instead
 the parameter with the LanguageModelName sub-parameter. If you want to
 include a custom vocabulary or a custom vocabulary filter (or both) with
 your request but do not want to use automatic language
 identification, use instead the parameter with the VocabularyName or
 VocabularyFilterName (or both) sub-parameter.
See: newLanguageIdSettings smart constructor.
Instances
newLanguageIdSettings :: LanguageIdSettings Source #
Create a value of LanguageIdSettings 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:languageModelName:LanguageIdSettings', languageIdSettings_languageModelName - The name of the custom language model you want to use when processing
 your transcription job. Note that custom language model names are case
 sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
$sel:vocabularyFilterName:LanguageIdSettings', languageIdSettings_vocabularyFilterName - The name of the custom vocabulary filter you want to use when processing
 your transcription job. Custom vocabulary filter names are case
 sensitive.
The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch.
Note that if you include VocabularyFilterName in your request, you
 must also include VocabularyFilterMethod.
$sel:vocabularyName:LanguageIdSettings', languageIdSettings_vocabularyName - The name of the custom vocabulary you want to use when processing your
 transcription job. Custom vocabulary names are case sensitive.
The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
LanguageModel
data LanguageModel Source #
Provides information about a custom language model, including the base model name, when the model was created, the location of the files used to train the model, when the model was last modified, the name you chose for the model, its language, its processing state, and if there is an upgrade available for the base model.
See: newLanguageModel smart constructor.
Constructors
| LanguageModel' (Maybe BaseModelName) (Maybe POSIX) (Maybe Text) (Maybe InputDataConfig) (Maybe CLMLanguageCode) (Maybe POSIX) (Maybe Text) (Maybe ModelStatus) (Maybe Bool) | 
Instances
newLanguageModel :: LanguageModel Source #
Create a value of LanguageModel 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:baseModelName:LanguageModel', languageModel_baseModelName - The Amazon Transcribe standard language model, or base model, used to
 create your custom language model.
$sel:createTime:LanguageModel', languageModel_createTime - The date and time the specified custom language model was created.
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 12:32 PM UTC-7 on
 May 4, 2022.
$sel:failureReason:LanguageModel', languageModel_failureReason - If ModelStatus is FAILED, FailureReason contains information about
 why the custom language model request failed. See also:
 Common Errors.
$sel:inputDataConfig:LanguageModel', languageModel_inputDataConfig - The Amazon S3 location of the input files used to train and tune your
 custom language model, in addition to the data access role ARN (Amazon
 Resource Name) that has permissions to access these data.
$sel:languageCode:LanguageModel', languageModel_languageCode - The language code used to create your custom language model. Each custom
 language model must contain terms in only one language, and the language
 you select for your custom language model must match the language of
 your training and tuning data.
For a list of supported languages and their associated language codes,
 refer to the
 Supported languages
 table. Note that U.S. English (en-US) is the only language supported
 with Amazon Transcribe Medical.
$sel:lastModifiedTime:LanguageModel', languageModel_lastModifiedTime - The date and time the specified custom language model was last modified.
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 12:32 PM UTC-7 on
 May 4, 2022.
$sel:modelName:LanguageModel', languageModel_modelName - A unique name, chosen by you, for your custom language model.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
$sel:modelStatus:LanguageModel', languageModel_modelStatus - The status of the specified custom language model. When the status
 displays as COMPLETED the model is ready for use.
$sel:upgradeAvailability:LanguageModel', languageModel_upgradeAvailability - Shows if a more current base model is available for use with the
 specified custom language model.
If false, your custom language model is using the most up-to-date base
 model.
If true, there is a newer base model available than the one your
 language model is using.
Note that to update a base model, you must recreate the custom language model using the new base model. Base model upgrades for existing custom language models are not supported.
Media
Describes the Amazon S3 location of the media file you want to use in your request.
For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.
See: newMedia smart constructor.
Instances
| FromJSON Media Source # | |
| ToJSON Media Source # | |
Defined in Amazonka.Transcribe.Types.Media  | |
| Generic Media Source # | |
| Read Media Source # | |
| Show Media Source # | |
| NFData Media Source # | |
Defined in Amazonka.Transcribe.Types.Media  | |
| Eq Media Source # | |
| Hashable Media Source # | |
Defined in Amazonka.Transcribe.Types.Media  | |
| type Rep Media Source # | |
Defined in Amazonka.Transcribe.Types.Media type Rep Media = D1 ('MetaData "Media" "Amazonka.Transcribe.Types.Media" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "Media'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mediaFileUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "redactedMediaFileUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))  | |
Create a value of Media 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:mediaFileUri:Media', media_mediaFileUri - The Amazon S3 location of the media file you want to transcribe. For
 example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
$sel:redactedMediaFileUri:Media', media_redactedMediaFileUri - The Amazon S3 location of the media file you want to redact. For
 example:
s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac
Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.
RedactedMediaFileUri produces a redacted audio file in addition to a
 redacted transcript. It is only supported for Call Analytics
 (StartCallAnalyticsJob) transcription requests.
MedicalTranscript
data MedicalTranscript Source #
Provides you with the Amazon S3 URI you can use to access your transcript.
See: newMedicalTranscript smart constructor.
Constructors
| MedicalTranscript' (Maybe Text) | 
Instances
newMedicalTranscript :: MedicalTranscript Source #
Create a value of MedicalTranscript 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:transcriptFileUri:MedicalTranscript', medicalTranscript_transcriptFileUri - The Amazon S3 location of your transcript. You can use this URI to
 access or download your transcript.
Note that this is the Amazon S3 location you specified in your request
 using the OutputBucketName parameter.
MedicalTranscriptionJob
data MedicalTranscriptionJob Source #
Provides detailed information about a medical transcription job.
To view the status of the specified medical transcription job, check the
 TranscriptionJobStatus field. If the status is COMPLETED, the job is
 finished and you can find the results at the location specified in
 TranscriptFileUri. If the status is FAILED, FailureReason provides
 details on why your transcription job failed.
See: newMedicalTranscriptionJob smart constructor.
Constructors
Instances
newMedicalTranscriptionJob :: MedicalTranscriptionJob Source #
Create a value of MedicalTranscriptionJob 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:completionTime:MedicalTranscriptionJob', medicalTranscriptionJob_completionTime - The date and time the specified medical transcription 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:contentIdentificationType:MedicalTranscriptionJob', medicalTranscriptionJob_contentIdentificationType - Indicates whether content identification was enabled for your
 transcription request.
$sel:creationTime:MedicalTranscriptionJob', medicalTranscriptionJob_creationTime - The date and time the specified medical transcription 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:MedicalTranscriptionJob', medicalTranscriptionJob_failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains
 information about why the transcription job request failed.
The FailureReason field contains one of the following values:
Unsupported media format.The media format specified in
MediaFormatisn'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
MediaFormatdoesn'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
MediaSampleRateHertzisn't valid. The sample rate must be between 16,000 and 48,000 hertz.The sample rate provided does not match the detected sample rate.The sample rate specified in
MediaSampleRateHertzdoesn'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:languageCode:MedicalTranscriptionJob', medicalTranscriptionJob_languageCode - The language code used to create your medical transcription job. US
 English (en-US) is the only supported language for medical
 transcriptions.
$sel:media:MedicalTranscriptionJob', medicalTranscriptionJob_media - Undocumented member.
$sel:mediaFormat:MedicalTranscriptionJob', medicalTranscriptionJob_mediaFormat - The format of the input media file.
$sel:mediaSampleRateHertz:MedicalTranscriptionJob', medicalTranscriptionJob_mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
$sel:medicalTranscriptionJobName:MedicalTranscriptionJob', medicalTranscriptionJob_medicalTranscriptionJobName - The name of the medical transcription job. Job names are case sensitive
 and must be unique within an Amazon Web Services account.
$sel:settings:MedicalTranscriptionJob', medicalTranscriptionJob_settings - Provides information on any additional settings that were included in
 your request. Additional settings include channel identification,
 alternative transcriptions, speaker partitioning, custom vocabularies,
 and custom vocabulary filters.
$sel:specialty:MedicalTranscriptionJob', medicalTranscriptionJob_specialty - Describes the medical specialty represented in your media.
$sel:startTime:MedicalTranscriptionJob', medicalTranscriptionJob_startTime - The date and time the specified medical transcription 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:tags:MedicalTranscriptionJob', medicalTranscriptionJob_tags - The tags, each in the form of a key:value pair, assigned to the
 specified medical transcription job.
$sel:transcript:MedicalTranscriptionJob', medicalTranscriptionJob_transcript - Provides you with the Amazon S3 URI you can use to access your
 transcript.
$sel:transcriptionJobStatus:MedicalTranscriptionJob', medicalTranscriptionJob_transcriptionJobStatus - Provides the status of the specified medical transcription job.
If the status is COMPLETED, the job is finished and you can find the
 results at the location specified in TranscriptFileUri. If the status
 is FAILED, FailureReason provides details on why your transcription
 job failed.
$sel:type':MedicalTranscriptionJob', medicalTranscriptionJob_type - Indicates whether the input media is a dictation or a conversation, as
 specified in the StartMedicalTranscriptionJob request.
MedicalTranscriptionJobSummary
data MedicalTranscriptionJobSummary Source #
Provides detailed information about a specific medical transcription job.
See: newMedicalTranscriptionJobSummary smart constructor.
Constructors
Instances
newMedicalTranscriptionJobSummary :: MedicalTranscriptionJobSummary Source #
Create a value of MedicalTranscriptionJobSummary 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:completionTime:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_completionTime - The date and time the specified medical transcription 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:contentIdentificationType:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_contentIdentificationType - Labels all personal health information (PHI) identified in your
 transcript. For more information, see
 Identifying personal health information (PHI) in a transcription.
$sel:creationTime:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_creationTime - The date and time the specified medical transcription 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:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains
 information about why the transcription job failed. See also:
 Common Errors.
$sel:languageCode:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_languageCode - The language code used to create your medical transcription. US English
 (en-US) is the only supported language for medical transcriptions.
$sel:medicalTranscriptionJobName:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_medicalTranscriptionJobName - The name of the medical transcription job. Job names are case sensitive
 and must be unique within an Amazon Web Services account.
$sel:outputLocationType:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_outputLocationType - Indicates where the specified medical transcription output is stored.
If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket
 you specified using the OutputBucketName parameter in your request. If
 you also included OutputKey in your request, your output is located in
 the path you specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed
 Amazon S3 bucket. To access a transcript stored in a service-managed
 bucket, use the URI shown in the TranscriptFileUri field.
$sel:specialty:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_specialty - Provides the medical specialty represented in your media.
$sel:startTime:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_startTime - The date and time your medical transcription 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:transcriptionJobStatus:MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_transcriptionJobStatus - Provides the status of your medical transcription job.
If the status is COMPLETED, the job is finished and you can find the
 results at the location specified in TranscriptFileUri. If the status
 is FAILED, FailureReason provides details on why your transcription
 job failed.
$sel:type':MedicalTranscriptionJobSummary', medicalTranscriptionJobSummary_type - Indicates whether the input media is a dictation or a conversation, as
 specified in the StartMedicalTranscriptionJob request.
MedicalTranscriptionSetting
data MedicalTranscriptionSetting Source #
Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your medical transcription job.
See: newMedicalTranscriptionSetting smart constructor.
Constructors
| MedicalTranscriptionSetting' (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Text) | 
Instances
newMedicalTranscriptionSetting :: MedicalTranscriptionSetting Source #
Create a value of MedicalTranscriptionSetting 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:channelIdentification:MedicalTranscriptionSetting', medicalTranscriptionSetting_channelIdentification - Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
You can't include both ShowSpeakerLabels and ChannelIdentification
 in the same request. Including both parameters returns a
 BadRequestException.
For more information, see Transcribing multi-channel audio.
$sel:maxAlternatives:MedicalTranscriptionSetting', medicalTranscriptionSetting_maxAlternatives - Indicate the maximum number of alternative transcriptions you want
 Amazon Transcribe Medical to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives in your request, you must also include
 ShowAlternatives with a value of true.
For more information, see Alternative transcriptions.
$sel:maxSpeakerLabels:MedicalTranscriptionSetting', medicalTranscriptionSetting_maxSpeakerLabels - Specify the maximum number of speakers you want to partition in your
 media.
Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
If you specify the MaxSpeakerLabels field, you must set the
 ShowSpeakerLabels field to true.
$sel:showAlternatives:MedicalTranscriptionSetting', medicalTranscriptionSetting_showAlternatives - To include alternative transcriptions within your transcription output,
 include ShowAlternatives in your transcription request.
If you include ShowAlternatives, you must also include
 MaxAlternatives, which is the maximum number of alternative
 transcriptions you want Amazon Transcribe Medical to generate.
For more information, see Alternative transcriptions.
$sel:showSpeakerLabels:MedicalTranscriptionSetting', medicalTranscriptionSetting_showSpeakerLabels - Enables speaker partitioning (diarization) in your transcription output.
 Speaker partitioning labels the speech from individual speakers in your
 media file.
If you enable ShowSpeakerLabels in your request, you must also include
 MaxSpeakerLabels.
You can't include ShowSpeakerLabels and ChannelIdentification in
 the same request. Including both parameters returns a
 BadRequestException.
For more information, see Partitioning speakers (diarization).
$sel:vocabularyName:MedicalTranscriptionSetting', medicalTranscriptionSetting_vocabularyName - The name of the custom vocabulary you want to use when processing your
 medical transcription job. Custom vocabulary names are case sensitive.
The language of the specified custom vocabulary must match the language
 code that you specify in your transcription request. If the languages
 don't match, the custom vocabulary isn't applied. There are no errors
 or warnings associated with a language mismatch. US English (en-US) is
 the only valid language for Amazon Transcribe Medical.
ModelSettings
data ModelSettings Source #
Provides the name of the custom language model that was included in the specified transcription job.
Only use ModelSettings with the LanguageModelName sub-parameter if
 you're not using automatic language identification (). If using
 LanguageIdSettings in your request, this parameter contains a
 LanguageModelName sub-parameter.
See: newModelSettings smart constructor.
Constructors
| ModelSettings' (Maybe Text) | 
Instances
newModelSettings :: ModelSettings Source #
Create a value of ModelSettings 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:languageModelName:ModelSettings', modelSettings_languageModelName - The name of the custom language model you want to use when processing
 your transcription job. Note that custom language model names are case
 sensitive.
The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
NonTalkTimeFilter
data NonTalkTimeFilter Source #
Flag the presence or absence of periods of silence in your Call Analytics transcription output.
Rules using NonTalkTimeFilter are designed to match:
- The presence of silence at specified periods throughout the call
 - The presence of speech at specified periods throughout the call
 
See Rule criteria for batch categories for usage examples.
See: newNonTalkTimeFilter smart constructor.
Constructors
| NonTalkTimeFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe RelativeTimeRange) (Maybe Natural) | 
Instances
newNonTalkTimeFilter :: NonTalkTimeFilter Source #
Create a value of NonTalkTimeFilter 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:absoluteTimeRange:NonTalkTimeFilter', nonTalkTimeFilter_absoluteTimeRange - Makes it possible to specify a time range (in milliseconds) in your
 audio, during which you want to search for a period of silence. See for
 more detail.
$sel:negate:NonTalkTimeFilter', nonTalkTimeFilter_negate - Set to TRUE to flag periods of speech. Set to FALSE to flag periods
 of silence
$sel:relativeTimeRange:NonTalkTimeFilter', nonTalkTimeFilter_relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media
 file, during which you want to search for a period of silence. See for
 more detail.
$sel:threshold:NonTalkTimeFilter', nonTalkTimeFilter_threshold - Specify the duration, in milliseconds, of the period of silence that you
 want to flag. For example, you can flag a silent period that lasts
 30,000 milliseconds.
RelativeTimeRange
data RelativeTimeRange Source #
A time range, in percentage, between two points in your media file.
You can use StartPercentage and EndPercentage to search a custom
 segment. For example, setting StartPercentage to 10 and
 EndPercentage to 50 only searches for your specified criteria in the
 audio contained between the 10 percent mark and the 50 percent mark of
 your media file.
You can use also First to search from the start of the media file
 until the time that you specify. Or use Last to search from the time
 that you specify until the end of the media file. For example, setting
 First to 10 only searches for your specified criteria in the audio
 contained in the first 10 percent of the media file.
If you prefer to use milliseconds instead of percentage, see .
See: newRelativeTimeRange smart constructor.
Instances
newRelativeTimeRange :: RelativeTimeRange Source #
Create a value of RelativeTimeRange 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:endPercentage:RelativeTimeRange', relativeTimeRange_endPercentage - The time, in percentage, when Amazon Transcribe stops searching for the
 specified criteria in your media file. If you include EndPercentage in
 your request, you must also include StartPercentage.
$sel:first:RelativeTimeRange', relativeTimeRange_first - The time, in percentage, from the start of your media file until the
 specified value. Amazon Transcribe searches for your specified criteria
 in this time segment.
$sel:last:RelativeTimeRange', relativeTimeRange_last - The time, in percentage, from the specified value until the end of your
 media file. Amazon Transcribe searches for your specified criteria in
 this time segment.
$sel:startPercentage:RelativeTimeRange', relativeTimeRange_startPercentage - The time, in percentage, when Amazon Transcribe starts searching for the
 specified criteria in your media file. If you include StartPercentage
 in your request, you must also include EndPercentage.
Rule
A rule is a set of criteria that you can specify to flag an attribute in your Call Analytics output. Rules define a Call Analytics category.
Rules can include these parameters: , , , and .
To learn more about Call Analytics rules and categories, see Creating categories for batch transcriptions and Creating categories for streaming transcriptions.
To learn more about Call Analytics, see Analyzing call center audio with Call Analytics.
See: newRule smart constructor.
Constructors
| Rule' (Maybe InterruptionFilter) (Maybe NonTalkTimeFilter) (Maybe SentimentFilter) (Maybe TranscriptFilter) | 
Instances
Create a value of Rule 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:interruptionFilter:Rule', rule_interruptionFilter - Flag the presence or absence of interruptions in your Call Analytics
 transcription output. Refer to for more detail.
$sel:nonTalkTimeFilter:Rule', rule_nonTalkTimeFilter - Flag the presence or absence of periods of silence in your Call
 Analytics transcription output. Refer to for more detail.
$sel:sentimentFilter:Rule', rule_sentimentFilter - Flag the presence or absence of specific sentiments in your Call
 Analytics transcription output. Refer to for more detail.
$sel:transcriptFilter:Rule', rule_transcriptFilter - Flag the presence or absence of specific words or phrases in your Call
 Analytics transcription output. Refer to for more detail.
SentimentFilter
data SentimentFilter Source #
Flag the presence or absence of specific sentiments detected in your Call Analytics transcription output.
Rules using SentimentFilter are designed to match:
- The presence or absence of a positive sentiment felt by the customer, agent, or both at specified points in the call
 - The presence or absence of a negative sentiment felt by the customer, agent, or both at specified points in the call
 - The presence or absence of a neutral sentiment felt by the customer, agent, or both at specified points in the call
 - The presence or absence of a mixed sentiment felt by the customer, the agent, or both at specified points in the call
 
See Rule criteria for batch categories for usage examples.
See: newSentimentFilter smart constructor.
Constructors
| SentimentFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe ParticipantRole) (Maybe RelativeTimeRange) (NonEmpty SentimentValue) | 
Instances
Create a value of SentimentFilter 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:absoluteTimeRange:SentimentFilter', sentimentFilter_absoluteTimeRange - Makes it possible to specify a time range (in milliseconds) in your
 audio, during which you want to search for the specified sentiments. See
 for more detail.
$sel:negate:SentimentFilter', sentimentFilter_negate - Set to TRUE to flag the sentiments that you didn't include in your
 request. Set to FALSE to flag the sentiments that you specified in
 your request.
$sel:participantRole:SentimentFilter', sentimentFilter_participantRole - Specify the participant that you want to flag. Omitting this parameter
 is equivalent to specifying both participants.
$sel:relativeTimeRange:SentimentFilter', sentimentFilter_relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media
 file, during which you want to search for the specified sentiments. See
 for more detail.
$sel:sentiments:SentimentFilter', sentimentFilter_sentiments - Specify the sentiments that you want to flag.
Settings
Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker partitioning. You can use that to apply custom vocabularies to your transcription job.
See: newSettings smart constructor.
Constructors
| Settings' (Maybe Bool) (Maybe Natural) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe VocabularyFilterMethod) (Maybe Text) (Maybe Text) | 
Instances
newSettings :: Settings Source #
Create a value of Settings 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:channelIdentification:Settings', settings_channelIdentification - Enables channel identification in multi-channel audio.
Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.
You can't include both ShowSpeakerLabels and ChannelIdentification
 in the same request. Including both parameters returns a
 BadRequestException.
For more information, see Transcribing multi-channel audio.
$sel:maxAlternatives:Settings', settings_maxAlternatives - Indicate the maximum number of alternative transcriptions you want
 Amazon Transcribe to include in your transcript.
If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe, only the actual number of alternative transcriptions are included.
If you include MaxAlternatives in your request, you must also include
 ShowAlternatives with a value of true.
For more information, see Alternative transcriptions.
$sel:maxSpeakerLabels:Settings', settings_maxSpeakerLabels - Specify the maximum number of speakers you want to partition in your
 media.
Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.
If you specify the MaxSpeakerLabels field, you must set the
 ShowSpeakerLabels field to true.
$sel:showAlternatives:Settings', settings_showAlternatives - To include alternative transcriptions within your transcription output,
 include ShowAlternatives in your transcription request.
If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel.
If you include ShowAlternatives, you must also include
 MaxAlternatives, which is the maximum number of alternative
 transcriptions you want Amazon Transcribe to generate.
For more information, see Alternative transcriptions.
$sel:showSpeakerLabels:Settings', settings_showSpeakerLabels - Enables speaker partitioning (diarization) in your transcription output.
 Speaker partitioning labels the speech from individual speakers in your
 media file.
If you enable ShowSpeakerLabels in your request, you must also include
 MaxSpeakerLabels.
You can't include both ShowSpeakerLabels and ChannelIdentification
 in the same request. Including both parameters returns a
 BadRequestException.
For more information, see Partitioning speakers (diarization).
$sel:vocabularyFilterMethod:Settings', settings_vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to your
 transcript.
To replace words with ***, choose mask.
To delete words, choose remove.
To flag words without changing them, choose tag.
$sel:vocabularyFilterName:Settings', settings_vocabularyFilterName - The name of the custom vocabulary filter you want to use in your
 transcription job request. This name is case sensitive, cannot contain
 spaces, and must be unique within an Amazon Web Services account.
Note that if you include VocabularyFilterName in your request, you
 must also include VocabularyFilterMethod.
$sel:vocabularyName:Settings', settings_vocabularyName - The name of the custom vocabulary you want to use in your transcription
 job request. This name is case sensitive, cannot contain spaces, and
 must be unique within an Amazon Web Services account.
Subtitles
Generate subtitles for your media file with your transcription request.
You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip (or both) as your output format.
Note that your subtitle files are placed in the same location as your transcription output.
See: newSubtitles smart constructor.
Constructors
| Subtitles' (Maybe [SubtitleFormat]) (Maybe Natural) | 
Instances
| ToJSON Subtitles Source # | |
Defined in Amazonka.Transcribe.Types.Subtitles  | |
| Generic Subtitles Source # | |
| Read Subtitles Source # | |
| Show Subtitles Source # | |
| NFData Subtitles Source # | |
Defined in Amazonka.Transcribe.Types.Subtitles  | |
| Eq Subtitles Source # | |
| Hashable Subtitles Source # | |
Defined in Amazonka.Transcribe.Types.Subtitles  | |
| type Rep Subtitles Source # | |
Defined in Amazonka.Transcribe.Types.Subtitles type Rep Subtitles = D1 ('MetaData "Subtitles" "Amazonka.Transcribe.Types.Subtitles" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "Subtitles'" 'PrefixI 'True) (S1 ('MetaSel ('Just "formats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubtitleFormat])) :*: S1 ('MetaSel ('Just "outputStartIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))  | |
newSubtitles :: Subtitles Source #
Create a value of Subtitles 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:formats:Subtitles', subtitles_formats - Specify the output format for your subtitle file; if you select both
 WebVTT (vtt) and SubRip (srt) formats, two output files are
 generated.
$sel:outputStartIndex:Subtitles', subtitles_outputStartIndex - Specify the starting value that is assigned to the first subtitle
 segment.
The default start index for Amazon Transcribe is 0, which differs from
 the more widely used standard of 1. If you're uncertain which value
 to use, we recommend choosing 1, as this may improve compatibility
 with other services.
SubtitlesOutput
data SubtitlesOutput Source #
Provides information about your subtitle file, including format, start index, and Amazon S3 location.
See: newSubtitlesOutput smart constructor.
Constructors
| SubtitlesOutput' (Maybe [SubtitleFormat]) (Maybe Natural) (Maybe [Text]) | 
Instances
newSubtitlesOutput :: SubtitlesOutput Source #
Create a value of SubtitlesOutput 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:formats:SubtitlesOutput', subtitlesOutput_formats - Provides the format of your subtitle files. If your request included
 both WebVTT (vtt) and SubRip (srt) formats, both formats are shown.
$sel:outputStartIndex:SubtitlesOutput', subtitlesOutput_outputStartIndex - Provides the start index value for your subtitle files. If you did not
 specify a value in your request, the default value of 0 is used.
$sel:subtitleFileUris:SubtitlesOutput', subtitlesOutput_subtitleFileUris - The Amazon S3 location of your transcript. You can use this URI to
 access or download your subtitle file. Your subtitle file is stored in
 the same location as your transcript. If you specified both WebVTT and
 SubRip subtitle formats, two URIs are provided.
If you included OutputBucketName in your transcription job request,
 this is the URI of that bucket. If you also included OutputKey in your
 request, your output is located in the path you specified in your
 request.
If you didn't include OutputBucketName in your transcription job
 request, your subtitle file is stored in a service-managed bucket, and
 TranscriptFileUri provides you with a temporary URI you can use for
 secure access to your subtitle file.
Temporary URIs for service-managed Amazon S3 buckets are only valid for
 15 minutes. If you get an AccesDenied error, you can get a new
 temporary URI by running a GetTranscriptionJob or
 ListTranscriptionJob request.
Tag
Adds metadata, in the form of a key:value pair, to the specified resource.
For example, you could add the tag Department:Sales to a resource to
 indicate that it pertains to your organization's sales department. You
 can also use tags for tag-based access control.
To learn more about tagging, see Tagging resources.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag  | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag  | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag  | |
| type Rep Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Transcribe.Types.Tag" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))  | |
Create a value of Tag 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:key:Tag', tag_key - The first part of a key:value pair that forms a tag associated with a
 given resource. For example, in the tag Department:Sales, the key is
 'Department'.
$sel:value:Tag', tag_value - The second part of a key:value pair that forms a tag associated with a
 given resource. For example, in the tag Department:Sales, the value is
 'Sales'.
Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
Transcript
data Transcript Source #
Provides you with the Amazon S3 URI you can use to access your transcript.
See: newTranscript smart constructor.
Constructors
| Transcript' (Maybe Text) (Maybe Text) | 
Instances
newTranscript :: Transcript Source #
Create a value of Transcript 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:redactedTranscriptFileUri:Transcript', transcript_redactedTranscriptFileUri - The Amazon S3 location of your redacted transcript. You can use this URI
 to access or download your transcript.
If you included OutputBucketName in your transcription job request,
 this is the URI of that bucket. If you also included OutputKey in your
 request, your output is located in the path you specified in your
 request.
If you didn't include OutputBucketName in your transcription job
 request, your transcript is stored in a service-managed bucket, and
 RedactedTranscriptFileUri provides you with a temporary URI you can
 use for secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for
 15 minutes. If you get an AccesDenied error, you can get a new
 temporary URI by running a GetTranscriptionJob or
 ListTranscriptionJob request.
$sel:transcriptFileUri:Transcript', transcript_transcriptFileUri - The Amazon S3 location of your transcript. You can use this URI to
 access or download your transcript.
If you included OutputBucketName in your transcription job request,
 this is the URI of that bucket. If you also included OutputKey in your
 request, your output is located in the path you specified in your
 request.
If you didn't include OutputBucketName in your transcription job
 request, your transcript is stored in a service-managed bucket, and
 TranscriptFileUri provides you with a temporary URI you can use for
 secure access to your transcript.
Temporary URIs for service-managed Amazon S3 buckets are only valid for
 15 minutes. If you get an AccesDenied error, you can get a new
 temporary URI by running a GetTranscriptionJob or
 ListTranscriptionJob request.
TranscriptFilter
data TranscriptFilter Source #
Flag the presence or absence of specific words or phrases detected in your Call Analytics transcription output.
Rules using TranscriptFilter are designed to match:
- Custom words or phrases spoken by the agent, the customer, or both
 - Custom words or phrases not spoken by the agent, the customer, or either
 - Custom words or phrases that occur at a specific time frame
 
See Rule criteria for batch categories and Rule criteria for streaming categories for usage examples.
See: newTranscriptFilter smart constructor.
Constructors
| TranscriptFilter' (Maybe AbsoluteTimeRange) (Maybe Bool) (Maybe ParticipantRole) (Maybe RelativeTimeRange) TranscriptFilterType (NonEmpty Text) | 
Instances
Arguments
| :: TranscriptFilterType | |
| -> NonEmpty Text | |
| -> TranscriptFilter | 
Create a value of TranscriptFilter 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:absoluteTimeRange:TranscriptFilter', transcriptFilter_absoluteTimeRange - Makes it possible to specify a time range (in milliseconds) in your
 audio, during which you want to search for the specified key words or
 phrases. See for more detail.
$sel:negate:TranscriptFilter', transcriptFilter_negate - Set to TRUE to flag the absence of the phrase that you specified in
 your request. Set to FALSE to flag the presence of the phrase that you
 specified in your request.
$sel:participantRole:TranscriptFilter', transcriptFilter_participantRole - Specify the participant that you want to flag. Omitting this parameter
 is equivalent to specifying both participants.
$sel:relativeTimeRange:TranscriptFilter', transcriptFilter_relativeTimeRange - Makes it possible to specify a time range (in percentage) in your media
 file, during which you want to search for the specified key words or
 phrases. See for more detail.
$sel:transcriptFilterType:TranscriptFilter', transcriptFilter_transcriptFilterType - Flag the presence or absence of an exact match to the phrases that you
 specify. For example, if you specify the phrase "speak to a manager"
 as your Targets value, only that exact phrase is flagged.
Note that semantic matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager", your content is not flagged.
$sel:targets:TranscriptFilter', transcriptFilter_targets - Specify the phrases that you want to flag.
TranscriptionJob
data TranscriptionJob Source #
Provides detailed information about a transcription job.
To view the status of the specified transcription job, check the
 TranscriptionJobStatus field. If the status is COMPLETED, the job is
 finished and you can find the results at the location specified in
 TranscriptFileUri. If the status is FAILED, FailureReason provides
 details on why your transcription job failed.
If you enabled content redaction, the redacted transcript can be found
 at the location specified in RedactedTranscriptFileUri.
See: newTranscriptionJob smart constructor.
Constructors
| TranscriptionJob' (Maybe POSIX) (Maybe ContentRedaction) (Maybe POSIX) (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe JobExecutionSettings) (Maybe LanguageCode) (Maybe [LanguageCodeItem]) (Maybe (HashMap LanguageCode LanguageIdSettings)) (Maybe (NonEmpty LanguageCode)) (Maybe Media) (Maybe MediaFormat) (Maybe Natural) (Maybe ModelSettings) (Maybe Settings) (Maybe POSIX) (Maybe SubtitlesOutput) (Maybe (NonEmpty Tag)) (Maybe Transcript) (Maybe Text) (Maybe TranscriptionJobStatus) | 
Instances
newTranscriptionJob :: TranscriptionJob Source #
Create a value of TranscriptionJob 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:completionTime:TranscriptionJob', transcriptionJob_completionTime - The date and time the specified transcription 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:contentRedaction:TranscriptionJob', transcriptionJob_contentRedaction - Indicates whether redaction was enabled in your transcript.
$sel:creationTime:TranscriptionJob', transcriptionJob_creationTime - The date and time the specified transcription 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:TranscriptionJob', transcriptionJob_failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains
 information about why the transcription job request failed.
The FailureReason field contains one of the following values:
Unsupported media format.The media format specified in
MediaFormatisn'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
MediaFormatdoesn'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
MediaSampleRateHertzisn'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
MediaSampleRateHertzdoesn'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:TranscriptionJob', transcriptionJob_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:identifyLanguage:TranscriptionJob', transcriptionJob_identifyLanguage - Indicates whether automatic language identification was enabled (TRUE)
 for the specified transcription job.
$sel:identifyMultipleLanguages:TranscriptionJob', transcriptionJob_identifyMultipleLanguages - Indicates whether automatic multi-language identification was enabled
 (TRUE) for the specified transcription job.
$sel:jobExecutionSettings:TranscriptionJob', transcriptionJob_jobExecutionSettings - Provides information about how your transcription job was processed.
 This parameter shows if your request was queued and what data access
 role was used.
TranscriptionJob, transcriptionJob_languageCode - The language code used to create your transcription job. This parameter
 is used with single-language identification. For multi-language
 identification requests, refer to the plural version of this parameter,
 LanguageCodes.
$sel:languageCodes:TranscriptionJob', transcriptionJob_languageCodes - The language codes used to create your transcription job. This parameter
 is used with multi-language identification. For single-language
 identification requests, refer to the singular version of this
 parameter, LanguageCode.
$sel:languageIdSettings:TranscriptionJob', transcriptionJob_languageIdSettings - Provides the name and language of all custom language models, custom
 vocabularies, and custom vocabulary filters that you included in your
 request.
$sel:languageOptions:TranscriptionJob', transcriptionJob_languageOptions - Provides the language codes you specified in your request.
$sel:media:TranscriptionJob', transcriptionJob_media - Provides the Amazon S3 location of the media file you used in your
 request.
$sel:mediaFormat:TranscriptionJob', transcriptionJob_mediaFormat - The format of the input media file.
$sel:mediaSampleRateHertz:TranscriptionJob', transcriptionJob_mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.
$sel:modelSettings:TranscriptionJob', transcriptionJob_modelSettings - Provides information on the custom language model you included in your
 request.
$sel:settings:TranscriptionJob', transcriptionJob_settings - Provides information on any additional settings that were included in
 your request. Additional settings include channel identification,
 alternative transcriptions, speaker partitioning, custom vocabularies,
 and custom vocabulary filters.
$sel:startTime:TranscriptionJob', transcriptionJob_startTime - The date and time the specified transcription 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:subtitles:TranscriptionJob', transcriptionJob_subtitles - Indicates whether subtitles were generated with your transcription.
$sel:tags:TranscriptionJob', transcriptionJob_tags - The tags, each in the form of a key:value pair, assigned to the
 specified transcription job.
$sel:transcript:TranscriptionJob', transcriptionJob_transcript - Provides you with the Amazon S3 URI you can use to access your
 transcript.
$sel:transcriptionJobName:TranscriptionJob', transcriptionJob_transcriptionJobName - The name of the transcription job. Job names are case sensitive and must
 be unique within an Amazon Web Services account.
$sel:transcriptionJobStatus:TranscriptionJob', transcriptionJob_transcriptionJobStatus - Provides the status of the specified transcription 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.
TranscriptionJobSummary
data TranscriptionJobSummary Source #
Provides detailed information about a specific transcription job.
See: newTranscriptionJobSummary smart constructor.
Constructors
| TranscriptionJobSummary' (Maybe POSIX) (Maybe ContentRedaction) (Maybe POSIX) (Maybe Text) (Maybe Double) (Maybe Bool) (Maybe Bool) (Maybe LanguageCode) (Maybe [LanguageCodeItem]) (Maybe ModelSettings) (Maybe OutputLocationType) (Maybe POSIX) (Maybe Text) (Maybe TranscriptionJobStatus) | 
Instances
newTranscriptionJobSummary :: TranscriptionJobSummary Source #
Create a value of TranscriptionJobSummary 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:completionTime:TranscriptionJobSummary', transcriptionJobSummary_completionTime - The date and time the specified transcription 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:contentRedaction:TranscriptionJobSummary', transcriptionJobSummary_contentRedaction - The content redaction settings of the transcription job.
$sel:creationTime:TranscriptionJobSummary', transcriptionJobSummary_creationTime - The date and time the specified transcription 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:TranscriptionJobSummary', transcriptionJobSummary_failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains
 information about why the transcription job failed. See also:
 Common Errors.
$sel:identifiedLanguageScore:TranscriptionJobSummary', transcriptionJobSummary_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:identifyLanguage:TranscriptionJobSummary', transcriptionJobSummary_identifyLanguage - Indicates whether automatic language identification was enabled (TRUE)
 for the specified transcription job.
$sel:identifyMultipleLanguages:TranscriptionJobSummary', transcriptionJobSummary_identifyMultipleLanguages - Indicates whether automatic multi-language identification was enabled
 (TRUE) for the specified transcription job.
TranscriptionJobSummary, transcriptionJobSummary_languageCode - The language code used to create your transcription.
$sel:languageCodes:TranscriptionJobSummary', transcriptionJobSummary_languageCodes - The language codes used to create your transcription job. This parameter
 is used with multi-language identification. For single-language
 identification, the singular version of this parameter, LanguageCode,
 is present.
$sel:modelSettings:TranscriptionJobSummary', transcriptionJobSummary_modelSettings - Undocumented member.
$sel:outputLocationType:TranscriptionJobSummary', transcriptionJobSummary_outputLocationType - Indicates where the specified transcription output is stored.
If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket
 you specified using the OutputBucketName parameter in your request. If
 you also included OutputKey in your request, your output is located in
 the path you specified in your request.
If the value is SERVICE_BUCKET, the location is a service-managed
 Amazon S3 bucket. To access a transcript stored in a service-managed
 bucket, use the URI shown in the TranscriptFileUri or
 RedactedTranscriptFileUri field.
$sel:startTime:TranscriptionJobSummary', transcriptionJobSummary_startTime - The date and time your transcription 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:transcriptionJobName:TranscriptionJobSummary', transcriptionJobSummary_transcriptionJobName - The name of the transcription job. Job names are case sensitive and must
 be unique within an Amazon Web Services account.
$sel:transcriptionJobStatus:TranscriptionJobSummary', transcriptionJobSummary_transcriptionJobStatus - Provides the status of your transcription 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.
VocabularyFilterInfo
data VocabularyFilterInfo Source #
Provides information about a custom vocabulary filter, including the language of the filter, when it was last modified, and its name.
See: newVocabularyFilterInfo smart constructor.
Constructors
| VocabularyFilterInfo' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) | 
Instances
newVocabularyFilterInfo :: VocabularyFilterInfo Source #
Create a value of VocabularyFilterInfo 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:languageCode:VocabularyFilterInfo', vocabularyFilterInfo_languageCode - The language code that represents the language of the entries in your
 vocabulary filter. Each custom vocabulary filter must contain terms in
 only one language.
A custom vocabulary filter can only be used to transcribe files in the
 same language as the filter. For example, if you create a custom
 vocabulary filter using US English (en-US), you can only apply this
 filter to files that contain English audio.
For a list of supported languages and their associated language codes, refer to the Supported languages table.
$sel:lastModifiedTime:VocabularyFilterInfo', vocabularyFilterInfo_lastModifiedTime - The date and time the specified custom vocabulary filter was last
 modified.
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 12:32 PM UTC-7 on
 May 4, 2022.
$sel:vocabularyFilterName:VocabularyFilterInfo', vocabularyFilterInfo_vocabularyFilterName - A unique name, chosen by you, for your custom vocabulary filter. This
 name is case sensitive, cannot contain spaces, and must be unique within
 an Amazon Web Services account.
VocabularyInfo
data VocabularyInfo Source #
Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.
See: newVocabularyInfo smart constructor.
Constructors
| VocabularyInfo' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) (Maybe VocabularyState) | 
Instances
newVocabularyInfo :: VocabularyInfo Source #
Create a value of VocabularyInfo 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:languageCode:VocabularyInfo', vocabularyInfo_languageCode - The language code used to create your custom vocabulary. Each custom
 vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same
 language as the custom vocabulary. For example, if you create a custom
 vocabulary using US English (en-US), you can only apply this custom
 vocabulary to files that contain English audio.
$sel:lastModifiedTime:VocabularyInfo', vocabularyInfo_lastModifiedTime - The date and time the specified custom vocabulary was last modified.
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 12:32 PM UTC-7 on
 May 4, 2022.
$sel:vocabularyName:VocabularyInfo', vocabularyInfo_vocabularyName - A unique name, chosen by you, for your custom vocabulary. This name is
 case sensitive, cannot contain spaces, and must be unique within an
 Amazon Web Services account.
$sel:vocabularyState:VocabularyInfo', vocabularyInfo_vocabularyState - The processing state of your custom vocabulary. If the state is READY,
 you can use the custom vocabulary in a StartTranscriptionJob request.