Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Waiters
- Operations
- ListLanguageModels
- GetVocabulary
- DeleteLanguageModel
- GetTranscriptionJob
- StartMedicalTranscriptionJob
- ListCallAnalyticsJobs
- ListTagsForResource
- GetCallAnalyticsCategory
- DeleteMedicalVocabulary
- UpdateMedicalVocabulary
- CreateCallAnalyticsCategory
- DeleteTranscriptionJob
- DescribeLanguageModel
- ListCallAnalyticsCategories
- DeleteMedicalTranscriptionJob
- DeleteVocabulary
- StartCallAnalyticsJob
- UpdateVocabulary
- CreateVocabularyFilter
- GetMedicalTranscriptionJob
- GetVocabularyFilter
- GetMedicalVocabulary
- DeleteCallAnalyticsJob
- CreateMedicalVocabulary
- ListMedicalVocabularies
- DeleteCallAnalyticsCategory
- UpdateCallAnalyticsCategory
- GetCallAnalyticsJob
- TagResource
- ListTranscriptionJobs
- ListMedicalTranscriptionJobs
- UntagResource
- DeleteVocabularyFilter
- ListVocabularyFilters
- UpdateVocabularyFilter
- ListVocabularies
- CreateVocabulary
- CreateLanguageModel
- StartTranscriptionJob
- Types
- BaseModelName
- CLMLanguageCode
- CallAnalyticsJobStatus
- LanguageCode
- MediaFormat
- MedicalContentIdentificationType
- ModelStatus
- OutputLocationType
- ParticipantRole
- RedactionOutput
- RedactionType
- SentimentValue
- Specialty
- SubtitleFormat
- TranscriptFilterType
- TranscriptionJobStatus
- Type
- VocabularyFilterMethod
- VocabularyState
- AbsoluteTimeRange
- CallAnalyticsJob
- CallAnalyticsJobSettings
- CallAnalyticsJobSummary
- CategoryProperties
- ChannelDefinition
- ContentRedaction
- InputDataConfig
- InterruptionFilter
- JobExecutionSettings
- LanguageModel
- Media
- MedicalTranscript
- MedicalTranscriptionJob
- MedicalTranscriptionJobSummary
- MedicalTranscriptionSetting
- ModelSettings
- NonTalkTimeFilter
- RelativeTimeRange
- Rule
- SentimentFilter
- Settings
- Subtitles
- SubtitlesOutput
- Tag
- Transcript
- TranscriptFilter
- TranscriptionJob
- TranscriptionJobSummary
- VocabularyFilterInfo
- VocabularyInfo
Derived from API version 2017-10-26
of the AWS service descriptions, licensed under Apache 2.0.
Operations and objects for transcribing speech to text.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListLanguageModels = ListLanguageModels' (Maybe Text) (Maybe Text) (Maybe ModelStatus) (Maybe Natural)
- newListLanguageModels :: ListLanguageModels
- data ListLanguageModelsResponse = ListLanguageModelsResponse' (Maybe Text) (Maybe [LanguageModel]) Int
- newListLanguageModelsResponse :: Int -> ListLanguageModelsResponse
- data GetVocabulary = GetVocabulary' Text
- newGetVocabulary :: Text -> GetVocabulary
- data GetVocabularyResponse = GetVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe VocabularyState) Int
- newGetVocabularyResponse :: Int -> GetVocabularyResponse
- data DeleteLanguageModel = DeleteLanguageModel' Text
- newDeleteLanguageModel :: Text -> DeleteLanguageModel
- data DeleteLanguageModelResponse = DeleteLanguageModelResponse' {
- newDeleteLanguageModelResponse :: DeleteLanguageModelResponse
- data GetTranscriptionJob = GetTranscriptionJob' Text
- newGetTranscriptionJob :: Text -> GetTranscriptionJob
- data GetTranscriptionJobResponse = GetTranscriptionJobResponse' (Maybe TranscriptionJob) Int
- newGetTranscriptionJobResponse :: Int -> GetTranscriptionJobResponse
- data StartMedicalTranscriptionJob = StartMedicalTranscriptionJob' (Maybe MedicalTranscriptionSetting) (Maybe MediaFormat) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe MedicalContentIdentificationType) (Maybe (NonEmpty Tag)) (Maybe Natural) Text LanguageCode Media Text Specialty Type
- newStartMedicalTranscriptionJob :: Text -> LanguageCode -> Media -> Text -> Specialty -> Type -> StartMedicalTranscriptionJob
- data StartMedicalTranscriptionJobResponse = StartMedicalTranscriptionJobResponse' (Maybe MedicalTranscriptionJob) Int
- newStartMedicalTranscriptionJobResponse :: Int -> StartMedicalTranscriptionJobResponse
- data ListCallAnalyticsJobs = ListCallAnalyticsJobs' (Maybe CallAnalyticsJobStatus) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListCallAnalyticsJobs :: ListCallAnalyticsJobs
- data ListCallAnalyticsJobsResponse = ListCallAnalyticsJobsResponse' (Maybe CallAnalyticsJobStatus) (Maybe [CallAnalyticsJobSummary]) (Maybe Text) Int
- newListCallAnalyticsJobsResponse :: Int -> ListCallAnalyticsJobsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data GetCallAnalyticsCategory = GetCallAnalyticsCategory' Text
- newGetCallAnalyticsCategory :: Text -> GetCallAnalyticsCategory
- data GetCallAnalyticsCategoryResponse = GetCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int
- newGetCallAnalyticsCategoryResponse :: Int -> GetCallAnalyticsCategoryResponse
- data DeleteMedicalVocabulary = DeleteMedicalVocabulary' Text
- newDeleteMedicalVocabulary :: Text -> DeleteMedicalVocabulary
- data DeleteMedicalVocabularyResponse = DeleteMedicalVocabularyResponse' {
- newDeleteMedicalVocabularyResponse :: DeleteMedicalVocabularyResponse
- data UpdateMedicalVocabulary = UpdateMedicalVocabulary' (Maybe Text) Text LanguageCode
- newUpdateMedicalVocabulary :: Text -> LanguageCode -> UpdateMedicalVocabulary
- data UpdateMedicalVocabularyResponse = UpdateMedicalVocabularyResponse' (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (Maybe VocabularyState) Int
- newUpdateMedicalVocabularyResponse :: Int -> UpdateMedicalVocabularyResponse
- data CreateCallAnalyticsCategory = CreateCallAnalyticsCategory' Text (NonEmpty Rule)
- newCreateCallAnalyticsCategory :: Text -> NonEmpty Rule -> CreateCallAnalyticsCategory
- data CreateCallAnalyticsCategoryResponse = CreateCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int
- newCreateCallAnalyticsCategoryResponse :: Int -> CreateCallAnalyticsCategoryResponse
- data DeleteTranscriptionJob = DeleteTranscriptionJob' Text
- newDeleteTranscriptionJob :: Text -> DeleteTranscriptionJob
- data DeleteTranscriptionJobResponse = DeleteTranscriptionJobResponse' {
- newDeleteTranscriptionJobResponse :: DeleteTranscriptionJobResponse
- data DescribeLanguageModel = DescribeLanguageModel' Text
- newDescribeLanguageModel :: Text -> DescribeLanguageModel
- data DescribeLanguageModelResponse = DescribeLanguageModelResponse' (Maybe LanguageModel) Int
- newDescribeLanguageModelResponse :: Int -> DescribeLanguageModelResponse
- data ListCallAnalyticsCategories = ListCallAnalyticsCategories' (Maybe Text) (Maybe Natural)
- newListCallAnalyticsCategories :: ListCallAnalyticsCategories
- data ListCallAnalyticsCategoriesResponse = ListCallAnalyticsCategoriesResponse' (Maybe [CategoryProperties]) (Maybe Text) Int
- newListCallAnalyticsCategoriesResponse :: Int -> ListCallAnalyticsCategoriesResponse
- data DeleteMedicalTranscriptionJob = DeleteMedicalTranscriptionJob' Text
- newDeleteMedicalTranscriptionJob :: Text -> DeleteMedicalTranscriptionJob
- data DeleteMedicalTranscriptionJobResponse = DeleteMedicalTranscriptionJobResponse' {
- newDeleteMedicalTranscriptionJobResponse :: DeleteMedicalTranscriptionJobResponse
- data DeleteVocabulary = DeleteVocabulary' Text
- newDeleteVocabulary :: Text -> DeleteVocabulary
- data DeleteVocabularyResponse = DeleteVocabularyResponse' {
- newDeleteVocabularyResponse :: DeleteVocabularyResponse
- data StartCallAnalyticsJob = StartCallAnalyticsJob' (Maybe CallAnalyticsJobSettings) (Maybe Text) (Maybe Text) (Maybe (NonEmpty ChannelDefinition)) Text Media Text
- newStartCallAnalyticsJob :: Text -> Media -> Text -> StartCallAnalyticsJob
- data StartCallAnalyticsJobResponse = StartCallAnalyticsJobResponse' (Maybe CallAnalyticsJob) Int
- newStartCallAnalyticsJobResponse :: Int -> StartCallAnalyticsJobResponse
- data UpdateVocabulary = UpdateVocabulary' (Maybe Text) (Maybe [Text]) Text LanguageCode
- newUpdateVocabulary :: Text -> LanguageCode -> UpdateVocabulary
- data UpdateVocabularyResponse = UpdateVocabularyResponse' (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (Maybe VocabularyState) Int
- newUpdateVocabularyResponse :: Int -> UpdateVocabularyResponse
- data CreateVocabularyFilter = CreateVocabularyFilter' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Tag)) Text LanguageCode
- newCreateVocabularyFilter :: Text -> LanguageCode -> CreateVocabularyFilter
- data CreateVocabularyFilterResponse = CreateVocabularyFilterResponse' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text) Int
- newCreateVocabularyFilterResponse :: Int -> CreateVocabularyFilterResponse
- data GetMedicalTranscriptionJob = GetMedicalTranscriptionJob' Text
- newGetMedicalTranscriptionJob :: Text -> GetMedicalTranscriptionJob
- data GetMedicalTranscriptionJobResponse = GetMedicalTranscriptionJobResponse' (Maybe MedicalTranscriptionJob) Int
- newGetMedicalTranscriptionJobResponse :: Int -> GetMedicalTranscriptionJobResponse
- data GetVocabularyFilter = GetVocabularyFilter' Text
- newGetVocabularyFilter :: Text -> GetVocabularyFilter
- data GetVocabularyFilterResponse = GetVocabularyFilterResponse' (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newGetVocabularyFilterResponse :: Int -> GetVocabularyFilterResponse
- data GetMedicalVocabulary = GetMedicalVocabulary' Text
- newGetMedicalVocabulary :: Text -> GetMedicalVocabulary
- data GetMedicalVocabularyResponse = GetMedicalVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe VocabularyState) Int
- newGetMedicalVocabularyResponse :: Int -> GetMedicalVocabularyResponse
- data DeleteCallAnalyticsJob = DeleteCallAnalyticsJob' Text
- newDeleteCallAnalyticsJob :: Text -> DeleteCallAnalyticsJob
- data DeleteCallAnalyticsJobResponse = DeleteCallAnalyticsJobResponse' Int
- newDeleteCallAnalyticsJobResponse :: Int -> DeleteCallAnalyticsJobResponse
- data CreateMedicalVocabulary = CreateMedicalVocabulary' (Maybe (NonEmpty Tag)) Text LanguageCode Text
- newCreateMedicalVocabulary :: Text -> LanguageCode -> Text -> CreateMedicalVocabulary
- data CreateMedicalVocabularyResponse = CreateMedicalVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (Maybe VocabularyState) Int
- newCreateMedicalVocabularyResponse :: Int -> CreateMedicalVocabularyResponse
- data ListMedicalVocabularies = ListMedicalVocabularies' (Maybe Text) (Maybe Text) (Maybe VocabularyState) (Maybe Natural)
- newListMedicalVocabularies :: ListMedicalVocabularies
- data ListMedicalVocabulariesResponse = ListMedicalVocabulariesResponse' (Maybe [VocabularyInfo]) (Maybe VocabularyState) (Maybe Text) Int
- newListMedicalVocabulariesResponse :: Int -> ListMedicalVocabulariesResponse
- data DeleteCallAnalyticsCategory = DeleteCallAnalyticsCategory' Text
- newDeleteCallAnalyticsCategory :: Text -> DeleteCallAnalyticsCategory
- data DeleteCallAnalyticsCategoryResponse = DeleteCallAnalyticsCategoryResponse' Int
- newDeleteCallAnalyticsCategoryResponse :: Int -> DeleteCallAnalyticsCategoryResponse
- data UpdateCallAnalyticsCategory = UpdateCallAnalyticsCategory' Text (NonEmpty Rule)
- newUpdateCallAnalyticsCategory :: Text -> NonEmpty Rule -> UpdateCallAnalyticsCategory
- data UpdateCallAnalyticsCategoryResponse = UpdateCallAnalyticsCategoryResponse' (Maybe CategoryProperties) Int
- newUpdateCallAnalyticsCategoryResponse :: Int -> UpdateCallAnalyticsCategoryResponse
- data GetCallAnalyticsJob = GetCallAnalyticsJob' Text
- newGetCallAnalyticsJob :: Text -> GetCallAnalyticsJob
- data GetCallAnalyticsJobResponse = GetCallAnalyticsJobResponse' (Maybe CallAnalyticsJob) Int
- newGetCallAnalyticsJobResponse :: Int -> GetCallAnalyticsJobResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListTranscriptionJobs = ListTranscriptionJobs' (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListTranscriptionJobs :: ListTranscriptionJobs
- data ListTranscriptionJobsResponse = ListTranscriptionJobsResponse' (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe [TranscriptionJobSummary]) Int
- newListTranscriptionJobsResponse :: Int -> ListTranscriptionJobsResponse
- data ListMedicalTranscriptionJobs = ListMedicalTranscriptionJobs' (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe Text) (Maybe Natural)
- newListMedicalTranscriptionJobs :: ListMedicalTranscriptionJobs
- data ListMedicalTranscriptionJobsResponse = ListMedicalTranscriptionJobsResponse' (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe [MedicalTranscriptionJobSummary]) Int
- newListMedicalTranscriptionJobsResponse :: Int -> ListMedicalTranscriptionJobsResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data DeleteVocabularyFilter = DeleteVocabularyFilter' Text
- newDeleteVocabularyFilter :: Text -> DeleteVocabularyFilter
- data DeleteVocabularyFilterResponse = DeleteVocabularyFilterResponse' {
- newDeleteVocabularyFilterResponse :: DeleteVocabularyFilterResponse
- data ListVocabularyFilters = ListVocabularyFilters' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListVocabularyFilters :: ListVocabularyFilters
- data ListVocabularyFiltersResponse = ListVocabularyFiltersResponse' (Maybe Text) (Maybe [VocabularyFilterInfo]) Int
- newListVocabularyFiltersResponse :: Int -> ListVocabularyFiltersResponse
- 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
- data ListVocabularies = ListVocabularies' (Maybe Text) (Maybe Text) (Maybe VocabularyState) (Maybe Natural)
- newListVocabularies :: ListVocabularies
- data ListVocabulariesResponse = ListVocabulariesResponse' (Maybe [VocabularyInfo]) (Maybe VocabularyState) (Maybe Text) Int
- newListVocabulariesResponse :: Int -> ListVocabulariesResponse
- data CreateVocabulary = CreateVocabulary' (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty Tag)) Text LanguageCode
- newCreateVocabulary :: Text -> LanguageCode -> CreateVocabulary
- data CreateVocabularyResponse = CreateVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (Maybe VocabularyState) Int
- newCreateVocabularyResponse :: Int -> CreateVocabularyResponse
- data CreateLanguageModel = CreateLanguageModel' (Maybe (NonEmpty Tag)) CLMLanguageCode BaseModelName Text InputDataConfig
- newCreateLanguageModel :: CLMLanguageCode -> BaseModelName -> Text -> InputDataConfig -> CreateLanguageModel
- data CreateLanguageModelResponse = CreateLanguageModelResponse' (Maybe CLMLanguageCode) (Maybe Text) (Maybe InputDataConfig) (Maybe BaseModelName) (Maybe ModelStatus) Int
- newCreateLanguageModelResponse :: Int -> CreateLanguageModelResponse
- data StartTranscriptionJob = StartTranscriptionJob' (Maybe ContentRedaction) (Maybe Subtitles) (Maybe LanguageCode) (Maybe (NonEmpty LanguageCode)) (Maybe Settings) (Maybe Text) (Maybe MediaFormat) (Maybe Text) (Maybe ModelSettings) (Maybe (HashMap Text Text)) (Maybe JobExecutionSettings) (Maybe Text) (Maybe Bool) (Maybe (NonEmpty Tag)) (Maybe Natural) Text Media
- newStartTranscriptionJob :: Text -> Media -> StartTranscriptionJob
- data StartTranscriptionJobResponse = StartTranscriptionJobResponse' (Maybe TranscriptionJob) Int
- newStartTranscriptionJobResponse :: Int -> StartTranscriptionJobResponse
- newtype BaseModelName where
- BaseModelName' { }
- pattern BaseModelName_NarrowBand :: BaseModelName
- pattern BaseModelName_WideBand :: BaseModelName
- newtype CLMLanguageCode where
- 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
- newtype CallAnalyticsJobStatus where
- newtype LanguageCode where
- LanguageCode' { }
- pattern LanguageCode_Af_ZA :: LanguageCode
- pattern LanguageCode_Ar_AE :: LanguageCode
- pattern LanguageCode_Ar_SA :: LanguageCode
- pattern LanguageCode_Cy_GB :: 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_Ga_IE :: LanguageCode
- pattern LanguageCode_Gd_GB :: 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_Ta_IN :: LanguageCode
- pattern LanguageCode_Te_IN :: LanguageCode
- pattern LanguageCode_Th_TH :: LanguageCode
- pattern LanguageCode_Tr_TR :: 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 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 POSIX) (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe Double) (Maybe LanguageCode) (Maybe CallAnalyticsJobSettings) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Media) (Maybe MediaFormat) (Maybe (NonEmpty ChannelDefinition)) (Maybe Text) (Maybe Transcript) (Maybe Natural)
- newCallAnalyticsJob :: CallAnalyticsJob
- data CallAnalyticsJobSettings = CallAnalyticsJobSettings' (Maybe ContentRedaction) (Maybe (NonEmpty LanguageCode)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VocabularyFilterMethod)
- newCallAnalyticsJobSettings :: CallAnalyticsJobSettings
- data CallAnalyticsJobSummary = CallAnalyticsJobSummary' (Maybe POSIX) (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe LanguageCode) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newCallAnalyticsJobSummary :: CallAnalyticsJobSummary
- data CategoryProperties = CategoryProperties' (Maybe (NonEmpty Rule)) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newCategoryProperties :: CategoryProperties
- data ChannelDefinition = ChannelDefinition' (Maybe ParticipantRole) (Maybe Natural)
- newChannelDefinition :: ChannelDefinition
- data ContentRedaction = ContentRedaction' RedactionType RedactionOutput
- newContentRedaction :: RedactionType -> RedactionOutput -> ContentRedaction
- data InputDataConfig = InputDataConfig' (Maybe Text) Text Text
- newInputDataConfig :: Text -> Text -> InputDataConfig
- data InterruptionFilter = InterruptionFilter' (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Bool) (Maybe Natural) (Maybe AbsoluteTimeRange)
- newInterruptionFilter :: InterruptionFilter
- data JobExecutionSettings = JobExecutionSettings' (Maybe Text) (Maybe Bool)
- newJobExecutionSettings :: JobExecutionSettings
- data LanguageModel = LanguageModel' (Maybe Text) (Maybe CLMLanguageCode) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe InputDataConfig) (Maybe BaseModelName) (Maybe ModelStatus) (Maybe POSIX)
- newLanguageModel :: LanguageModel
- data Media = Media' (Maybe Text) (Maybe Text)
- newMedia :: Media
- data MedicalTranscript = MedicalTranscript' (Maybe Text)
- newMedicalTranscript :: MedicalTranscript
- data MedicalTranscriptionJob = MedicalTranscriptionJob' (Maybe POSIX) (Maybe Specialty) (Maybe Text) (Maybe LanguageCode) (Maybe MedicalTranscriptionSetting) (Maybe POSIX) (Maybe POSIX) (Maybe Media) (Maybe MediaFormat) (Maybe Text) (Maybe TranscriptionJobStatus) (Maybe Type) (Maybe MedicalContentIdentificationType) (Maybe MedicalTranscript) (Maybe (NonEmpty Tag)) (Maybe Natural)
- newMedicalTranscriptionJob :: MedicalTranscriptionJob
- data MedicalTranscriptionJobSummary = MedicalTranscriptionJobSummary' (Maybe POSIX) (Maybe Specialty) (Maybe Text) (Maybe LanguageCode) (Maybe OutputLocationType) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe TranscriptionJobStatus) (Maybe Type) (Maybe MedicalContentIdentificationType)
- newMedicalTranscriptionJobSummary :: MedicalTranscriptionJobSummary
- data MedicalTranscriptionSetting = MedicalTranscriptionSetting' (Maybe Text) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Bool)
- newMedicalTranscriptionSetting :: MedicalTranscriptionSetting
- data ModelSettings = ModelSettings' (Maybe Text)
- newModelSettings :: ModelSettings
- data NonTalkTimeFilter = NonTalkTimeFilter' (Maybe RelativeTimeRange) (Maybe Bool) (Maybe Natural) (Maybe AbsoluteTimeRange)
- newNonTalkTimeFilter :: NonTalkTimeFilter
- data RelativeTimeRange = RelativeTimeRange' (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural)
- newRelativeTimeRange :: RelativeTimeRange
- data Rule = Rule' (Maybe NonTalkTimeFilter) (Maybe TranscriptFilter) (Maybe SentimentFilter) (Maybe InterruptionFilter)
- newRule :: Rule
- data SentimentFilter = SentimentFilter' (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Bool) (Maybe AbsoluteTimeRange) (NonEmpty SentimentValue)
- newSentimentFilter :: NonEmpty SentimentValue -> SentimentFilter
- data Settings = Settings' (Maybe Text) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe VocabularyFilterMethod)
- newSettings :: Settings
- data Subtitles = Subtitles' (Maybe [SubtitleFormat])
- newSubtitles :: Subtitles
- data SubtitlesOutput = SubtitlesOutput' (Maybe [SubtitleFormat]) (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 ParticipantRole) (Maybe RelativeTimeRange) (Maybe Bool) (Maybe AbsoluteTimeRange) TranscriptFilterType (NonEmpty Text)
- newTranscriptFilter :: TranscriptFilterType -> NonEmpty Text -> TranscriptFilter
- data TranscriptionJob = TranscriptionJob' (Maybe POSIX) (Maybe Text) (Maybe ContentRedaction) (Maybe Double) (Maybe SubtitlesOutput) (Maybe LanguageCode) (Maybe (NonEmpty LanguageCode)) (Maybe Settings) (Maybe POSIX) (Maybe POSIX) (Maybe Media) (Maybe MediaFormat) (Maybe ModelSettings) (Maybe TranscriptionJobStatus) (Maybe JobExecutionSettings) (Maybe Text) (Maybe Bool) (Maybe Transcript) (Maybe (NonEmpty Tag)) (Maybe Natural)
- newTranscriptionJob :: TranscriptionJob
- data TranscriptionJobSummary = TranscriptionJobSummary' (Maybe POSIX) (Maybe Text) (Maybe ContentRedaction) (Maybe Double) (Maybe LanguageCode) (Maybe OutputLocationType) (Maybe POSIX) (Maybe POSIX) (Maybe ModelSettings) (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe Bool)
- newTranscriptionJobSummary :: TranscriptionJobSummary
- data VocabularyFilterInfo = VocabularyFilterInfo' (Maybe LanguageCode) (Maybe POSIX) (Maybe Text)
- newVocabularyFilterInfo :: VocabularyFilterInfo
- data VocabularyInfo = VocabularyInfo' (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (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
.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is already a resource with that name.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find the requested resource. Check the name and try your request again.
InternalFailureException
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was an internal error. Check the error message and try your request again.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request didn't pass one or more validation tests. For example, if
the entity that you're trying to delete doesn't exist or if it is in a
non-terminal state (for example, it's "in progress"). See the
exception Message
field for more information.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.
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.
ListLanguageModels
data ListLanguageModels Source #
See: newListLanguageModels
smart constructor.
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:nameContains:ListLanguageModels'
, listLanguageModels_nameContains
- When specified, the custom language model names returned contain the
substring you've specified.
$sel:nextToken:ListLanguageModels'
, listLanguageModels_nextToken
- When included, fetches the next set of jobs if the result of the
previous request was truncated.
$sel:statusEquals:ListLanguageModels'
, listLanguageModels_statusEquals
- When specified, returns only custom language models with the specified
status. Language models are ordered by creation date, with the newest
models first. If you don't specify a status, Amazon Transcribe returns
all custom language models ordered by date.
$sel:maxResults:ListLanguageModels'
, listLanguageModels_maxResults
- The maximum number of language models to return in each page of results.
If there are fewer results than the value you specify, only the actual
results are returned. If you do not specify a value, the default of 5 is
used.
data ListLanguageModelsResponse Source #
See: newListLanguageModelsResponse
smart constructor.
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:nextToken:ListLanguageModels'
, listLanguageModelsResponse_nextToken
- The operation returns a page of jobs at a time. The maximum size of the
list is set by the MaxResults parameter. If there are more language
models in the list than the page size, Amazon Transcribe returns the
NextPage
token. Include the token in the next request to the operation
to return the next page of language models.
$sel:models:ListLanguageModelsResponse'
, listLanguageModelsResponse_models
- A list of objects containing information about custom language models.
$sel:httpStatus:ListLanguageModelsResponse'
, listLanguageModelsResponse_httpStatus
- The response's http status code.
GetVocabulary
data GetVocabulary Source #
See: newGetVocabulary
smart constructor.
Instances
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:
$sel:vocabularyName:GetVocabulary'
, getVocabulary_vocabularyName
- The name of the vocabulary to return information about. The name is case
sensitive.
data GetVocabularyResponse Source #
See: newGetVocabularyResponse
smart constructor.
GetVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (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:failureReason:GetVocabularyResponse'
, getVocabularyResponse_failureReason
- If the VocabularyState
field is FAILED
, this field contains
information about why the job failed.
$sel:languageCode:GetVocabularyResponse'
, getVocabularyResponse_languageCode
- The language code of the vocabulary entries.
$sel:downloadUri:GetVocabularyResponse'
, getVocabularyResponse_downloadUri
- The S3 location where the vocabulary is stored. Use this URI to get the
contents of the vocabulary. The URI is available for a limited time.
$sel:vocabularyName:GetVocabulary'
, getVocabularyResponse_vocabularyName
- The name of the vocabulary to return.
$sel:lastModifiedTime:GetVocabularyResponse'
, getVocabularyResponse_lastModifiedTime
- The date and time that the vocabulary was last modified.
$sel:vocabularyState:GetVocabularyResponse'
, getVocabularyResponse_vocabularyState
- The processing state of the vocabulary.
$sel:httpStatus:GetVocabularyResponse'
, getVocabularyResponse_httpStatus
- The response's http status code.
DeleteLanguageModel
data DeleteLanguageModel Source #
See: newDeleteLanguageModel
smart constructor.
Instances
newDeleteLanguageModel Source #
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:
$sel:modelName:DeleteLanguageModel'
, deleteLanguageModel_modelName
- The name of the model you're choosing to delete.
data DeleteLanguageModelResponse Source #
See: newDeleteLanguageModelResponse
smart constructor.
Instances
newDeleteLanguageModelResponse :: DeleteLanguageModelResponse Source #
Create a value of DeleteLanguageModelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetTranscriptionJob
data GetTranscriptionJob Source #
See: newGetTranscriptionJob
smart constructor.
Instances
newGetTranscriptionJob Source #
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:
$sel:transcriptionJobName:GetTranscriptionJob'
, getTranscriptionJob_transcriptionJobName
- The name of the job.
data GetTranscriptionJobResponse Source #
See: newGetTranscriptionJobResponse
smart constructor.
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
- An object that contains the results of the transcription job.
$sel:httpStatus:GetTranscriptionJobResponse'
, getTranscriptionJobResponse_httpStatus
- The response's http status code.
StartMedicalTranscriptionJob
data StartMedicalTranscriptionJob Source #
See: newStartMedicalTranscriptionJob
smart constructor.
Instances
newStartMedicalTranscriptionJob Source #
:: 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:
$sel:settings:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_settings
- Optional settings for the medical transcription job.
$sel:mediaFormat:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_mediaFormat
- The audio format of the input media file.
$sel:outputEncryptionKMSKeyId:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_outputEncryptionKMSKeyId
- The Amazon Resource Name (ARN) of the Amazon Web Services Key Management
Service (KMS) key used to encrypt the output of the transcription job.
The user calling the StartMedicalTranscriptionJob operation must have
permission to use the specified KMS key.
You use either of the following to identify a KMS key in the current account:
- KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
- KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
- Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the medical transcription job 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 in the OutputBucketName
parameter.
$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.
$sel:outputKey:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_outputKey
- You can specify a location in an Amazon S3 bucket to store the output of
your medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the
OutputBucketName
parameter.
$sel:contentIdentificationType:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_contentIdentificationType
- You can configure Amazon Transcribe Medical to label content in the
transcription output. If you specify PHI
, Amazon Transcribe Medical
labels the personal health information (PHI) that it identifies in the
transcription output.
$sel:tags:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_tags
- Add tags to an Amazon Transcribe medical transcription job.
$sel:mediaSampleRateHertz:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe Medical
determines the sample rate. If you specify the sample rate, it must
match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MediaSampleRateHertz
field blank and let Amazon
Transcribe Medical determine the sample rate.
$sel:medicalTranscriptionJobName:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_medicalTranscriptionJobName
- The name of the medical transcription job. You can't use the strings
".
" or "..
" by themselves as the job name. The name must also be
unique within an Amazon Web Services account. If you try to create a
medical transcription job with the same name as a previous medical
transcription job, you get a ConflictException
error.
$sel:languageCode:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_languageCode
- The language code for the language spoken in the input media file. US
English (en-US) is the valid value for medical transcription jobs. Any
other value you enter for language code results in a
BadRequestException
error.
$sel:media:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_media
- Undocumented member.
$sel:outputBucketName:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_outputBucketName
- The Amazon S3 location where the transcription is stored.
You must set OutputBucketName
for Amazon Transcribe Medical to store
the transcription results. Your transcript appears in the S3 location
you specify. When you call the GetMedicalTranscriptionJob, the operation
returns this location in the TranscriptFileUri
field. The S3 bucket
must have permissions that allow Amazon Transcribe Medical to put files
in the bucket. For more information, see
Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key
to encrypt the output of your transcription using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key,
Amazon Transcribe Medical uses the default Amazon S3 key for server-side
encryption of transcripts that are placed in your S3 bucket.
$sel:specialty:StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_specialty
- The medical specialty of any clinician speaking in the input media.
$sel:type':StartMedicalTranscriptionJob'
, startMedicalTranscriptionJob_type
- The type of speech in the input audio. CONVERSATION
refers to
conversations between two or more speakers, e.g., a conversations
between doctors and patients. DICTATION
refers to single-speaker
dictated speech, such as clinical notes.
data StartMedicalTranscriptionJobResponse Source #
See: newStartMedicalTranscriptionJobResponse
smart constructor.
Instances
newStartMedicalTranscriptionJobResponse Source #
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
- A batch job submitted to transcribe medical speech to text.
$sel:httpStatus:StartMedicalTranscriptionJobResponse'
, startMedicalTranscriptionJobResponse_httpStatus
- The response's http status code.
ListCallAnalyticsJobs
data ListCallAnalyticsJobs Source #
See: newListCallAnalyticsJobs
smart constructor.
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:status:ListCallAnalyticsJobs'
, listCallAnalyticsJobs_status
- When specified, returns only call analytics jobs with the specified
status. Jobs are ordered by creation date, with the most recent jobs
returned first. If you don't specify a status, Amazon Transcribe
returns all analytics jobs ordered by creation date.
$sel:nextToken:ListCallAnalyticsJobs'
, listCallAnalyticsJobs_nextToken
- If you receive a truncated result in the previous request of , include
NextToken
to fetch the next set of jobs.
$sel:jobNameContains:ListCallAnalyticsJobs'
, listCallAnalyticsJobs_jobNameContains
- When specified, the jobs returned in the list are limited to jobs whose
name contains the specified string.
$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 you specify, only the
actual results are returned. If you do not specify a value, the default
of 5 is used.
data ListCallAnalyticsJobsResponse Source #
See: newListCallAnalyticsJobsResponse
smart constructor.
ListCallAnalyticsJobsResponse' (Maybe CallAnalyticsJobStatus) (Maybe [CallAnalyticsJobSummary]) (Maybe Text) 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:status:ListCallAnalyticsJobs'
, listCallAnalyticsJobsResponse_status
- When specified, returns only call analytics jobs with that status. Jobs
are ordered by creation date, with the most recent jobs returned first.
If you don't specify a status, Amazon Transcribe returns all
transcription jobs ordered by creation date.
$sel:callAnalyticsJobSummaries:ListCallAnalyticsJobsResponse'
, listCallAnalyticsJobsResponse_callAnalyticsJobSummaries
- A list of objects containing summary information for a transcription
job.
$sel:nextToken:ListCallAnalyticsJobs'
, listCallAnalyticsJobsResponse_nextToken
- The operation returns a page of jobs at a time. The maximum size of the
page is set by the MaxResults
parameter. If there are more jobs in the
list than the page size, Amazon Transcribe returns the NextPage
token.
Include the token in your next request to the operation to return next
page of jobs.
$sel:httpStatus:ListCallAnalyticsJobsResponse'
, listCallAnalyticsJobsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- Lists all tags associated with a given Amazon Resource Name (ARN).
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:
$sel:resourceArn:ListTagsForResource'
, listTagsForResourceResponse_resourceArn
- Lists all tags associated with the given Amazon Resource Name (ARN).
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- Lists all tags associated with the given transcription job, vocabulary,
or resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
GetCallAnalyticsCategory
data GetCallAnalyticsCategory Source #
See: newGetCallAnalyticsCategory
smart constructor.
Instances
newGetCallAnalyticsCategory Source #
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:
$sel:categoryName:GetCallAnalyticsCategory'
, getCallAnalyticsCategory_categoryName
- The name of the category you want information about. This value is case
sensitive.
data GetCallAnalyticsCategoryResponse Source #
See: newGetCallAnalyticsCategoryResponse
smart constructor.
Instances
Eq GetCallAnalyticsCategoryResponse Source # | |
Read GetCallAnalyticsCategoryResponse Source # | |
Show GetCallAnalyticsCategoryResponse Source # | |
Generic GetCallAnalyticsCategoryResponse Source # | |
NFData GetCallAnalyticsCategoryResponse Source # | |
Defined in Amazonka.Transcribe.GetCallAnalyticsCategory rnf :: GetCallAnalyticsCategoryResponse -> () # | |
type Rep GetCallAnalyticsCategoryResponse Source # | |
Defined in Amazonka.Transcribe.GetCallAnalyticsCategory type Rep GetCallAnalyticsCategoryResponse = D1 ('MetaData "GetCallAnalyticsCategoryResponse" "Amazonka.Transcribe.GetCallAnalyticsCategory" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "GetCallAnalyticsCategoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "categoryProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CategoryProperties)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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
- The rules you've defined for a category.
$sel:httpStatus:GetCallAnalyticsCategoryResponse'
, getCallAnalyticsCategoryResponse_httpStatus
- The response's http status code.
DeleteMedicalVocabulary
data DeleteMedicalVocabulary Source #
See: newDeleteMedicalVocabulary
smart constructor.
Instances
newDeleteMedicalVocabulary Source #
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:
$sel:vocabularyName:DeleteMedicalVocabulary'
, deleteMedicalVocabulary_vocabularyName
- The name of the vocabulary that you want to delete.
data DeleteMedicalVocabularyResponse Source #
See: newDeleteMedicalVocabularyResponse
smart constructor.
Instances
newDeleteMedicalVocabularyResponse :: DeleteMedicalVocabularyResponse Source #
Create a value of DeleteMedicalVocabularyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateMedicalVocabulary
data UpdateMedicalVocabulary Source #
See: newUpdateMedicalVocabulary
smart constructor.
Instances
newUpdateMedicalVocabulary Source #
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:
$sel:vocabularyFileUri:UpdateMedicalVocabulary'
, updateMedicalVocabulary_vocabularyFileUri
- The location in Amazon S3 of the text file that contains your custom
vocabulary. The URI must be in the same Amazon Web Services Region as
the resource that you are calling. The following is the format for a
URI:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
For example:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
$sel:vocabularyName:UpdateMedicalVocabulary'
, updateMedicalVocabulary_vocabularyName
- The name of the vocabulary to update. The name is case sensitive. If you
try to update a vocabulary with the same name as a vocabulary you've
already made, you get a ConflictException
error.
$sel:languageCode:UpdateMedicalVocabulary'
, updateMedicalVocabulary_languageCode
- The language code of the language used for the entries in the updated
vocabulary. US English (en-US) is the only valid language code in Amazon
Transcribe Medical.
data UpdateMedicalVocabularyResponse Source #
See: newUpdateMedicalVocabularyResponse
smart constructor.
UpdateMedicalVocabularyResponse' (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (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:
$sel:languageCode:UpdateMedicalVocabulary'
, updateMedicalVocabularyResponse_languageCode
- The language code for the language of the text file used to update the
custom vocabulary. US English (en-US) is the only language supported in
Amazon Transcribe Medical.
$sel:vocabularyName:UpdateMedicalVocabulary'
, updateMedicalVocabularyResponse_vocabularyName
- The name of the updated vocabulary.
$sel:lastModifiedTime:UpdateMedicalVocabularyResponse'
, updateMedicalVocabularyResponse_lastModifiedTime
- The date and time that the vocabulary was updated.
$sel:vocabularyState:UpdateMedicalVocabularyResponse'
, updateMedicalVocabularyResponse_vocabularyState
- The processing state of the update to the vocabulary. When the
VocabularyState
field is READY
, the vocabulary is ready to be used
in a StartMedicalTranscriptionJob
request.
$sel:httpStatus:UpdateMedicalVocabularyResponse'
, updateMedicalVocabularyResponse_httpStatus
- The response's http status code.
CreateCallAnalyticsCategory
data CreateCallAnalyticsCategory Source #
See: newCreateCallAnalyticsCategory
smart constructor.
Instances
newCreateCallAnalyticsCategory Source #
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:
$sel:categoryName:CreateCallAnalyticsCategory'
, createCallAnalyticsCategory_categoryName
- The name that you choose for your category when you create it.
$sel:rules:CreateCallAnalyticsCategory'
, createCallAnalyticsCategory_rules
- To create a category, you must specify between 1 and 20 rules. For each
rule, you specify a filter to be applied to the attributes of the call.
For example, you can specify a sentiment filter to detect if the
customer's sentiment was negative or neutral.
data CreateCallAnalyticsCategoryResponse Source #
See: newCreateCallAnalyticsCategoryResponse
smart constructor.
Instances
newCreateCallAnalyticsCategoryResponse Source #
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
- The rules and associated metadata used to create a category.
$sel:httpStatus:CreateCallAnalyticsCategoryResponse'
, createCallAnalyticsCategoryResponse_httpStatus
- The response's http status code.
DeleteTranscriptionJob
data DeleteTranscriptionJob Source #
See: newDeleteTranscriptionJob
smart constructor.
Instances
newDeleteTranscriptionJob Source #
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:
$sel:transcriptionJobName:DeleteTranscriptionJob'
, deleteTranscriptionJob_transcriptionJobName
- The name of the transcription job to be deleted.
data DeleteTranscriptionJobResponse Source #
See: newDeleteTranscriptionJobResponse
smart constructor.
Instances
newDeleteTranscriptionJobResponse :: DeleteTranscriptionJobResponse Source #
Create a value of DeleteTranscriptionJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeLanguageModel
data DescribeLanguageModel Source #
See: newDescribeLanguageModel
smart constructor.
Instances
newDescribeLanguageModel Source #
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:
$sel:modelName:DescribeLanguageModel'
, describeLanguageModel_modelName
- The name of the custom language model you submit to get more
information.
data DescribeLanguageModelResponse Source #
See: newDescribeLanguageModelResponse
smart constructor.
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
- The name of the custom language model you requested more information
about.
$sel:httpStatus:DescribeLanguageModelResponse'
, describeLanguageModelResponse_httpStatus
- The response's http status code.
ListCallAnalyticsCategories
data ListCallAnalyticsCategories Source #
See: newListCallAnalyticsCategories
smart constructor.
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:nextToken:ListCallAnalyticsCategories'
, listCallAnalyticsCategories_nextToken
- When included, NextToken
fetches the next set of categories if the
result of the previous request was truncated.
$sel:maxResults:ListCallAnalyticsCategories'
, listCallAnalyticsCategories_maxResults
- The maximum number of categories to return in each page of results. If
there are fewer results than the value you specify, only the actual
results are returned. If you do not specify a value, the default of 5 is
used.
data ListCallAnalyticsCategoriesResponse Source #
See: newListCallAnalyticsCategoriesResponse
smart constructor.
Instances
newListCallAnalyticsCategoriesResponse Source #
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
- A list of objects containing information about analytics categories.
$sel:nextToken:ListCallAnalyticsCategories'
, listCallAnalyticsCategoriesResponse_nextToken
- The operation returns a page of jobs at a time. The maximum size of the
list is set by the MaxResults
parameter. If there are more categories
in the list than the page size, Amazon Transcribe returns the NextPage
token. Include the token in the next request to the operation to return
the next page of analytics categories.
$sel:httpStatus:ListCallAnalyticsCategoriesResponse'
, listCallAnalyticsCategoriesResponse_httpStatus
- The response's http status code.
DeleteMedicalTranscriptionJob
data DeleteMedicalTranscriptionJob Source #
See: newDeleteMedicalTranscriptionJob
smart constructor.
Instances
newDeleteMedicalTranscriptionJob Source #
:: Text |
|
-> DeleteMedicalTranscriptionJob |
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:
$sel:medicalTranscriptionJobName:DeleteMedicalTranscriptionJob'
, deleteMedicalTranscriptionJob_medicalTranscriptionJobName
- The name you provide to the DeleteMedicalTranscriptionJob
object to
delete a transcription job.
data DeleteMedicalTranscriptionJobResponse Source #
See: newDeleteMedicalTranscriptionJobResponse
smart constructor.
Instances
Eq DeleteMedicalTranscriptionJobResponse Source # | |
Read DeleteMedicalTranscriptionJobResponse Source # | |
Show DeleteMedicalTranscriptionJobResponse Source # | |
Generic DeleteMedicalTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalTranscriptionJob type Rep DeleteMedicalTranscriptionJobResponse :: Type -> Type # | |
NFData DeleteMedicalTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalTranscriptionJob rnf :: DeleteMedicalTranscriptionJobResponse -> () # | |
type Rep DeleteMedicalTranscriptionJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteMedicalTranscriptionJob type Rep DeleteMedicalTranscriptionJobResponse = D1 ('MetaData "DeleteMedicalTranscriptionJobResponse" "Amazonka.Transcribe.DeleteMedicalTranscriptionJob" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "DeleteMedicalTranscriptionJobResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteMedicalTranscriptionJobResponse :: DeleteMedicalTranscriptionJobResponse Source #
Create a value of DeleteMedicalTranscriptionJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVocabulary
data DeleteVocabulary Source #
See: newDeleteVocabulary
smart constructor.
Instances
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:
$sel:vocabularyName:DeleteVocabulary'
, deleteVocabulary_vocabularyName
- The name of the vocabulary to delete.
data DeleteVocabularyResponse Source #
See: newDeleteVocabularyResponse
smart constructor.
Instances
Eq DeleteVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabulary | |
Read DeleteVocabularyResponse Source # | |
Show DeleteVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabulary showsPrec :: Int -> DeleteVocabularyResponse -> ShowS # show :: DeleteVocabularyResponse -> String # showList :: [DeleteVocabularyResponse] -> ShowS # | |
Generic DeleteVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabulary type Rep DeleteVocabularyResponse :: Type -> Type # | |
NFData DeleteVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabulary rnf :: DeleteVocabularyResponse -> () # | |
type Rep DeleteVocabularyResponse Source # | |
Defined in Amazonka.Transcribe.DeleteVocabulary |
newDeleteVocabularyResponse :: DeleteVocabularyResponse Source #
Create a value of DeleteVocabularyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartCallAnalyticsJob
data StartCallAnalyticsJob Source #
See: newStartCallAnalyticsJob
smart constructor.
StartCallAnalyticsJob' (Maybe CallAnalyticsJobSettings) (Maybe Text) (Maybe Text) (Maybe (NonEmpty ChannelDefinition)) Text Media Text |
Instances
newStartCallAnalyticsJob Source #
:: Text | |
-> Media | |
-> Text | |
-> 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:
$sel:settings:StartCallAnalyticsJob'
, startCallAnalyticsJob_settings
- A Settings
object that provides optional settings for a call analytics
job.
$sel:outputEncryptionKMSKeyId:StartCallAnalyticsJob'
, startCallAnalyticsJob_outputEncryptionKMSKeyId
- The Amazon Resource Name (ARN) of the Amazon Web Services Key Management
Service key used to encrypt the output of the call analytics job. The
user calling the operation must have permission to use the specified KMS
key.
You use either of the following to identify an Amazon Web Services KMS key in the current account:
- KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
- KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
- Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef1234567890ab"
- ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the call analytics job 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 in the OutputLocation
parameter.
$sel:outputLocation:StartCallAnalyticsJob'
, startCallAnalyticsJob_outputLocation
- The Amazon S3 location where the output of the call analytics job is
stored. You can provide the following location types to store the output
of call analytics job:
s3://DOC-EXAMPLE-BUCKET1
If you specify a bucket, Amazon Transcribe saves the output of the analytics job as a JSON file at the root level of the bucket.
s3://DOC-EXAMPLE-BUCKET1/folder/
f you specify a path, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json
If you specify a folder, you must provide a trailing slash.
s3://DOC-EXAMPLE-BUCKET1/folder/filename.json
If you provide a path that has the filename specified, Amazon Transcribe saves the output of the analytics job as s3://DOC-EXAMPLEBUCKET1/folder/filename.json
You can specify an Amazon Web Services Key Management Service (KMS) key
to encrypt the output of our analytics job using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key,
Amazon Transcribe uses the default Amazon S3 key for server-side
encryption of the analytics job output that is placed in your S3 bucket.
$sel:channelDefinitions:StartCallAnalyticsJob'
, startCallAnalyticsJob_channelDefinitions
- When you start a call analytics job, you must pass an array that maps
the agent and the customer to specific audio channels. The values you
can assign to a channel are 0 and 1. The agent and the customer must
each have their own channel. You can't assign more than one channel to
an agent or customer.
$sel:callAnalyticsJobName:StartCallAnalyticsJob'
, startCallAnalyticsJob_callAnalyticsJobName
- The name of the call analytics job. You can't use the string "." or
".." by themselves as the job name. The name must also be unique
within an Amazon Web Services account. If you try to create a call
analytics job with the same name as a previous call analytics job, you
get a ConflictException
error.
$sel:media:StartCallAnalyticsJob'
, startCallAnalyticsJob_media
- Undocumented member.
$sel:dataAccessRoleArn:StartCallAnalyticsJob'
, startCallAnalyticsJob_dataAccessRoleArn
- The Amazon Resource Name (ARN) of a role that has access to the S3
bucket that contains your input files. Amazon Transcribe assumes this
role to read queued audio files. If you have specified an output S3
bucket for your transcription results, this role should have access to
the output bucket as well.
data StartCallAnalyticsJobResponse Source #
See: newStartCallAnalyticsJobResponse
smart constructor.
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
- An object containing the details of the asynchronous call analytics job.
$sel:httpStatus:StartCallAnalyticsJobResponse'
, startCallAnalyticsJobResponse_httpStatus
- The response's http status code.
UpdateVocabulary
data UpdateVocabulary Source #
See: newUpdateVocabulary
smart constructor.
Instances
:: 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:vocabularyFileUri:UpdateVocabulary'
, updateVocabulary_vocabularyFileUri
- The S3 location of the text file that contains the definition of the
custom vocabulary. The URI must be in the same region as the API
endpoint that you are calling. The general form is
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
$sel:phrases:UpdateVocabulary'
, updateVocabulary_phrases
- An array of strings containing the vocabulary entries.
$sel:vocabularyName:UpdateVocabulary'
, updateVocabulary_vocabularyName
- The name of the vocabulary to update. The name is case sensitive. If you
try to update a vocabulary with the same name as a previous vocabulary
you will receive a ConflictException
error.
$sel:languageCode:UpdateVocabulary'
, updateVocabulary_languageCode
- The language code of the vocabulary entries. For a list of languages and
their corresponding language codes, see transcribe-whatis.
data UpdateVocabularyResponse Source #
See: newUpdateVocabularyResponse
smart constructor.
UpdateVocabularyResponse' (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (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:
$sel:languageCode:UpdateVocabulary'
, updateVocabularyResponse_languageCode
- The language code of the vocabulary entries.
$sel:vocabularyName:UpdateVocabulary'
, updateVocabularyResponse_vocabularyName
- The name of the vocabulary that was updated.
$sel:lastModifiedTime:UpdateVocabularyResponse'
, updateVocabularyResponse_lastModifiedTime
- The date and time that the vocabulary was updated.
$sel:vocabularyState:UpdateVocabularyResponse'
, updateVocabularyResponse_vocabularyState
- The processing state of the vocabulary. When the VocabularyState
field
contains READY
the vocabulary is ready to be used in a
StartTranscriptionJob
request.
$sel:httpStatus:UpdateVocabularyResponse'
, updateVocabularyResponse_httpStatus
- The response's http status code.
CreateVocabularyFilter
data CreateVocabularyFilter Source #
See: newCreateVocabularyFilter
smart constructor.
CreateVocabularyFilter' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Tag)) Text LanguageCode |
Instances
newCreateVocabularyFilter Source #
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:
$sel:vocabularyFilterFileUri:CreateVocabularyFilter'
, createVocabularyFilter_vocabularyFilterFileUri
- The Amazon S3 location of a text file used as input to create the
vocabulary filter. Only use characters from the character set defined
for custom vocabularies. For a list of character sets, see
Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the
VocabularyFilterFileUri
parameter, you can't use the Words
parameter.
$sel:words:CreateVocabularyFilter'
, createVocabularyFilter_words
- The words to use in the vocabulary filter. Only use characters from the
character set defined for custom vocabularies. For a list of character
sets, see
Character Sets for Custom Vocabularies.
If you provide a list of words in the Words
parameter, you can't use
the VocabularyFilterFileUri
parameter.
$sel:tags:CreateVocabularyFilter'
, createVocabularyFilter_tags
- Adds one or more tags, each in the form of a key:value pair, to a new
Amazon Transcribe vocabulary filter at the time you create this new
vocabulary filter.
$sel:vocabularyFilterName:CreateVocabularyFilter'
, createVocabularyFilter_vocabularyFilterName
- The vocabulary filter name. The name must be unique within the account
that contains it. If you try to create a vocabulary filter with the same
name as another vocabulary filter, you get a ConflictException
error.
$sel:languageCode:CreateVocabularyFilter'
, createVocabularyFilter_languageCode
- The language code of the words in the vocabulary filter. All words in
the filter must be in the same language. The vocabulary filter can only
be used with transcription jobs in the specified language.
data CreateVocabularyFilterResponse Source #
See: newCreateVocabularyFilterResponse
smart constructor.
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:
$sel:languageCode:CreateVocabularyFilter'
, createVocabularyFilterResponse_languageCode
- The language code of the words in the collection.
$sel:lastModifiedTime:CreateVocabularyFilterResponse'
, createVocabularyFilterResponse_lastModifiedTime
- The date and time that the vocabulary filter was modified.
$sel:vocabularyFilterName:CreateVocabularyFilter'
, createVocabularyFilterResponse_vocabularyFilterName
- The name of the vocabulary filter.
$sel:httpStatus:CreateVocabularyFilterResponse'
, createVocabularyFilterResponse_httpStatus
- The response's http status code.
GetMedicalTranscriptionJob
data GetMedicalTranscriptionJob Source #
See: newGetMedicalTranscriptionJob
smart constructor.
Instances
newGetMedicalTranscriptionJob Source #
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:
$sel:medicalTranscriptionJobName:GetMedicalTranscriptionJob'
, getMedicalTranscriptionJob_medicalTranscriptionJobName
- The name of the medical transcription job.
data GetMedicalTranscriptionJobResponse Source #
See: newGetMedicalTranscriptionJobResponse
smart constructor.
Instances
newGetMedicalTranscriptionJobResponse Source #
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
- An object that contains the results of the medical transcription job.
$sel:httpStatus:GetMedicalTranscriptionJobResponse'
, getMedicalTranscriptionJobResponse_httpStatus
- The response's http status code.
GetVocabularyFilter
data GetVocabularyFilter Source #
See: newGetVocabularyFilter
smart constructor.
Instances
newGetVocabularyFilter Source #
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:
$sel:vocabularyFilterName:GetVocabularyFilter'
, getVocabularyFilter_vocabularyFilterName
- The name of the vocabulary filter for which to return information.
data GetVocabularyFilterResponse Source #
See: newGetVocabularyFilterResponse
smart constructor.
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:languageCode:GetVocabularyFilterResponse'
, getVocabularyFilterResponse_languageCode
- The language code of the words in the vocabulary filter.
$sel:downloadUri:GetVocabularyFilterResponse'
, getVocabularyFilterResponse_downloadUri
- The URI of the list of words in the vocabulary filter. You can use this
URI to get the list of words.
$sel:lastModifiedTime:GetVocabularyFilterResponse'
, getVocabularyFilterResponse_lastModifiedTime
- The date and time that the contents of the vocabulary filter were
updated.
$sel:vocabularyFilterName:GetVocabularyFilter'
, getVocabularyFilterResponse_vocabularyFilterName
- The name of the vocabulary filter.
$sel:httpStatus:GetVocabularyFilterResponse'
, getVocabularyFilterResponse_httpStatus
- The response's http status code.
GetMedicalVocabulary
data GetMedicalVocabulary Source #
See: newGetMedicalVocabulary
smart constructor.
Instances
newGetMedicalVocabulary Source #
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:
$sel:vocabularyName:GetMedicalVocabulary'
, getMedicalVocabulary_vocabularyName
- The name of the vocabulary that you want information about. The value is
case sensitive.
data GetMedicalVocabularyResponse Source #
See: newGetMedicalVocabularyResponse
smart constructor.
GetMedicalVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe Text) (Maybe POSIX) (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:failureReason:GetMedicalVocabularyResponse'
, getMedicalVocabularyResponse_failureReason
- If the VocabularyState
is FAILED
, this field contains information
about why the job failed.
$sel:languageCode:GetMedicalVocabularyResponse'
, getMedicalVocabularyResponse_languageCode
- The valid language code for your vocabulary entries.
$sel:downloadUri:GetMedicalVocabularyResponse'
, getMedicalVocabularyResponse_downloadUri
- The location in Amazon S3 where the vocabulary is stored. Use this URI
to get the contents of the vocabulary. You can download your vocabulary
from the URI for a limited time.
$sel:vocabularyName:GetMedicalVocabulary'
, getMedicalVocabularyResponse_vocabularyName
- The name of the vocabulary returned by Amazon Transcribe Medical.
$sel:lastModifiedTime:GetMedicalVocabularyResponse'
, getMedicalVocabularyResponse_lastModifiedTime
- The date and time that the vocabulary was last modified with a text file
different from the one that was previously used.
$sel:vocabularyState:GetMedicalVocabularyResponse'
, getMedicalVocabularyResponse_vocabularyState
- The processing state of the vocabulary. If the VocabularyState
is
READY
then you can use it in the StartMedicalTranscriptionJob
operation.
$sel:httpStatus:GetMedicalVocabularyResponse'
, getMedicalVocabularyResponse_httpStatus
- The response's http status code.
DeleteCallAnalyticsJob
data DeleteCallAnalyticsJob Source #
See: newDeleteCallAnalyticsJob
smart constructor.
Instances
newDeleteCallAnalyticsJob Source #
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:
$sel:callAnalyticsJobName:DeleteCallAnalyticsJob'
, deleteCallAnalyticsJob_callAnalyticsJobName
- The name of the call analytics job you want to delete.
data DeleteCallAnalyticsJobResponse Source #
See: newDeleteCallAnalyticsJobResponse
smart constructor.
Instances
Eq DeleteCallAnalyticsJobResponse Source # | |
Read DeleteCallAnalyticsJobResponse Source # | |
Show DeleteCallAnalyticsJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteCallAnalyticsJob | |
Generic DeleteCallAnalyticsJobResponse Source # | |
NFData DeleteCallAnalyticsJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteCallAnalyticsJob rnf :: DeleteCallAnalyticsJobResponse -> () # | |
type Rep DeleteCallAnalyticsJobResponse Source # | |
Defined in Amazonka.Transcribe.DeleteCallAnalyticsJob type Rep DeleteCallAnalyticsJobResponse = D1 ('MetaData "DeleteCallAnalyticsJobResponse" "Amazonka.Transcribe.DeleteCallAnalyticsJob" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "DeleteCallAnalyticsJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
CreateMedicalVocabulary
data CreateMedicalVocabulary Source #
See: newCreateMedicalVocabulary
smart constructor.
Instances
newCreateMedicalVocabulary Source #
:: 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:
$sel:tags:CreateMedicalVocabulary'
, createMedicalVocabulary_tags
- Adds one or more tags, each in the form of a key:value pair, to a new
medical vocabulary at the time you create this new vocabulary.
$sel:vocabularyName:CreateMedicalVocabulary'
, createMedicalVocabulary_vocabularyName
- The name of the custom vocabulary. This case-sensitive name must be
unique within an Amazon Web Services account. If you try to create a
vocabulary with the same name as a previous vocabulary, you get a
ConflictException
error.
$sel:languageCode:CreateMedicalVocabulary'
, createMedicalVocabulary_languageCode
- The language code for the language used for the entries in your custom
vocabulary. The language code of your custom vocabulary must match the
language code of your transcription job. US English (en-US) is the only
language code available for Amazon Transcribe Medical.
$sel:vocabularyFileUri:CreateMedicalVocabulary'
, createMedicalVocabulary_vocabularyFileUri
- The location in Amazon S3 of the text file you use to define your custom
vocabulary. The URI must be in the same Amazon Web Services Region as
the resource that you're calling. Enter information about your
VocabularyFileUri
in the following format:
https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
The following is an example URI for a vocabulary file that is stored in Amazon S3:
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Medical Custom Vocabularies.
data CreateMedicalVocabularyResponse Source #
See: newCreateMedicalVocabularyResponse
smart constructor.
CreateMedicalVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (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:
$sel:failureReason:CreateMedicalVocabularyResponse'
, createMedicalVocabularyResponse_failureReason
- If the VocabularyState
field is FAILED
, this field contains
information about why the job failed.
$sel:languageCode:CreateMedicalVocabulary'
, createMedicalVocabularyResponse_languageCode
- The language code for the entries in your custom vocabulary. US English
(en-US) is the only valid language code for Amazon Transcribe Medical.
$sel:vocabularyName:CreateMedicalVocabulary'
, createMedicalVocabularyResponse_vocabularyName
- The name of the vocabulary. The name must be unique within an Amazon Web
Services account and is case sensitive.
$sel:lastModifiedTime:CreateMedicalVocabularyResponse'
, createMedicalVocabularyResponse_lastModifiedTime
- The date and time that you created the vocabulary.
$sel:vocabularyState:CreateMedicalVocabularyResponse'
, createMedicalVocabularyResponse_vocabularyState
- The processing state of your custom vocabulary in Amazon Transcribe
Medical. If the state is READY
, you can use the vocabulary in a
StartMedicalTranscriptionJob
request.
$sel:httpStatus:CreateMedicalVocabularyResponse'
, createMedicalVocabularyResponse_httpStatus
- The response's http status code.
ListMedicalVocabularies
data ListMedicalVocabularies Source #
See: newListMedicalVocabularies
smart constructor.
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:nameContains:ListMedicalVocabularies'
, listMedicalVocabularies_nameContains
- Returns vocabularies whose names contain the specified string. The
search is not case sensitive. ListMedicalVocabularies
returns both
"vocabularyname
" and "VocabularyName
".
$sel:nextToken:ListMedicalVocabularies'
, listMedicalVocabularies_nextToken
- If the result of your previous request to ListMedicalVocabularies
was
truncated, include the NextToken
to fetch the next set of
vocabularies.
$sel:stateEquals:ListMedicalVocabularies'
, listMedicalVocabularies_stateEquals
- When specified, returns only vocabularies with the VocabularyState
equal to the specified vocabulary state. Use this field to see which
vocabularies are ready for your medical transcription jobs.
$sel:maxResults:ListMedicalVocabularies'
, listMedicalVocabularies_maxResults
- The maximum number of vocabularies to return in each page of results. If
there are fewer results than the value you specify, only the actual
results are returned. If you do not specify a value, the default of 5 is
used.
data ListMedicalVocabulariesResponse Source #
See: newListMedicalVocabulariesResponse
smart constructor.
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:
$sel:vocabularies:ListMedicalVocabulariesResponse'
, listMedicalVocabulariesResponse_vocabularies
- A list of objects that describe the vocabularies that match your search
criteria.
$sel:status:ListMedicalVocabulariesResponse'
, listMedicalVocabulariesResponse_status
- The requested vocabulary state.
$sel:nextToken:ListMedicalVocabularies'
, listMedicalVocabulariesResponse_nextToken
- The ListMedicalVocabularies
operation returns a page of vocabularies
at a time. You set the maximum number of vocabularies to return on a
page with the MaxResults
parameter. If there are more jobs in the list
will fit on a page, Amazon Transcribe Medical returns the NextPage
token. To return the next page of vocabularies, include the token in the
next request to the ListMedicalVocabularies
operation .
$sel:httpStatus:ListMedicalVocabulariesResponse'
, listMedicalVocabulariesResponse_httpStatus
- The response's http status code.
DeleteCallAnalyticsCategory
data DeleteCallAnalyticsCategory Source #
See: newDeleteCallAnalyticsCategory
smart constructor.
Instances
newDeleteCallAnalyticsCategory Source #
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:
$sel:categoryName:DeleteCallAnalyticsCategory'
, deleteCallAnalyticsCategory_categoryName
- The name of the call analytics category that you're choosing to delete.
The value is case sensitive.
data DeleteCallAnalyticsCategoryResponse Source #
See: newDeleteCallAnalyticsCategoryResponse
smart constructor.
Instances
Eq DeleteCallAnalyticsCategoryResponse Source # | |
Read DeleteCallAnalyticsCategoryResponse Source # | |
Show DeleteCallAnalyticsCategoryResponse Source # | |
Generic DeleteCallAnalyticsCategoryResponse Source # | |
Defined in Amazonka.Transcribe.DeleteCallAnalyticsCategory type Rep DeleteCallAnalyticsCategoryResponse :: Type -> Type # | |
NFData DeleteCallAnalyticsCategoryResponse Source # | |
Defined in Amazonka.Transcribe.DeleteCallAnalyticsCategory rnf :: DeleteCallAnalyticsCategoryResponse -> () # | |
type Rep DeleteCallAnalyticsCategoryResponse Source # | |
Defined in Amazonka.Transcribe.DeleteCallAnalyticsCategory type Rep DeleteCallAnalyticsCategoryResponse = D1 ('MetaData "DeleteCallAnalyticsCategoryResponse" "Amazonka.Transcribe.DeleteCallAnalyticsCategory" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "DeleteCallAnalyticsCategoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeleteCallAnalyticsCategoryResponse Source #
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.
UpdateCallAnalyticsCategory
data UpdateCallAnalyticsCategory Source #
See: newUpdateCallAnalyticsCategory
smart constructor.
Instances
newUpdateCallAnalyticsCategory Source #
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:
$sel:categoryName:UpdateCallAnalyticsCategory'
, updateCallAnalyticsCategory_categoryName
- The name of the analytics category to update. The name is case
sensitive. If you try to update a call analytics category with the same
name as a previous category you will receive a ConflictException
error.
$sel:rules:UpdateCallAnalyticsCategory'
, updateCallAnalyticsCategory_rules
- The rules used for the updated analytics category. The rules that you
provide in this field replace the ones that are currently being used.
data UpdateCallAnalyticsCategoryResponse Source #
See: newUpdateCallAnalyticsCategoryResponse
smart constructor.
Instances
newUpdateCallAnalyticsCategoryResponse Source #
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
- The attributes describing the analytics category. You can see
information such as the rules that you've used to update the category
and when the category was originally created.
$sel:httpStatus:UpdateCallAnalyticsCategoryResponse'
, updateCallAnalyticsCategoryResponse_httpStatus
- The response's http status code.
GetCallAnalyticsJob
data GetCallAnalyticsJob Source #
See: newGetCallAnalyticsJob
smart constructor.
Instances
newGetCallAnalyticsJob Source #
Create a value of GetCallAnalyticsJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:callAnalyticsJobName:GetCallAnalyticsJob'
, getCallAnalyticsJob_callAnalyticsJobName
- The name of the analytics job you want information about. This value is
case sensitive.
data GetCallAnalyticsJobResponse Source #
See: newGetCallAnalyticsJobResponse
smart constructor.
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
- An object that contains the results of your call analytics job.
$sel:httpStatus:GetCallAnalyticsJobResponse'
, getCallAnalyticsJobResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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 Amazon Transcribe resource you
want to tag.
$sel:tags:TagResource'
, tagResource_tags
- The tags you are assigning to a given Amazon Transcribe resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
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.
ListTranscriptionJobs
data ListTranscriptionJobs Source #
See: newListTranscriptionJobs
smart constructor.
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:status:ListTranscriptionJobs'
, listTranscriptionJobs_status
- When specified, returns only transcription jobs with the specified
status. Jobs are ordered by creation date, with the newest jobs returned
first. If you don’t specify a status, Amazon Transcribe returns all
transcription jobs ordered by creation date.
$sel:nextToken:ListTranscriptionJobs'
, listTranscriptionJobs_nextToken
- If the result of the previous request to ListTranscriptionJobs
is
truncated, include the NextToken
to fetch the next set of jobs.
$sel:jobNameContains:ListTranscriptionJobs'
, listTranscriptionJobs_jobNameContains
- When specified, the jobs returned in the list are limited to jobs whose
name contains the specified string.
$sel:maxResults:ListTranscriptionJobs'
, listTranscriptionJobs_maxResults
- The maximum number of jobs to return in each page of results. If there
are fewer results than the value you specify, only the actual results
are returned. If you do not specify a value, the default of 5 is used.
data ListTranscriptionJobsResponse Source #
See: newListTranscriptionJobsResponse
smart constructor.
ListTranscriptionJobsResponse' (Maybe TranscriptionJobStatus) (Maybe Text) (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:
$sel:status:ListTranscriptionJobs'
, listTranscriptionJobsResponse_status
- The requested status of the jobs returned.
$sel:nextToken:ListTranscriptionJobs'
, listTranscriptionJobsResponse_nextToken
- The ListTranscriptionJobs
operation returns a page of jobs at a time.
The maximum size of the page is set by the MaxResults
parameter. If
there are more jobs in the list than the page size, Amazon Transcribe
returns the NextPage
token. Include the token in the next request to
the ListTranscriptionJobs
operation to return in the next page of
jobs.
$sel:transcriptionJobSummaries:ListTranscriptionJobsResponse'
, listTranscriptionJobsResponse_transcriptionJobSummaries
- A list of objects containing summary information for a transcription
job.
$sel:httpStatus:ListTranscriptionJobsResponse'
, listTranscriptionJobsResponse_httpStatus
- The response's http status code.
ListMedicalTranscriptionJobs
data ListMedicalTranscriptionJobs Source #
See: newListMedicalTranscriptionJobs
smart constructor.
ListMedicalTranscriptionJobs' (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe Text) (Maybe Natural) |
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:status:ListMedicalTranscriptionJobs'
, listMedicalTranscriptionJobs_status
- When specified, returns only medical transcription jobs with the
specified status. Jobs are ordered by creation date, with the newest
jobs returned first. If you don't specify a status, Amazon Transcribe
Medical returns all transcription jobs ordered by creation date.
$sel:nextToken:ListMedicalTranscriptionJobs'
, listMedicalTranscriptionJobs_nextToken
- If you a receive a truncated result in the previous request of
ListMedicalTranscriptionJobs
, include NextToken
to fetch the next
set of jobs.
$sel:jobNameContains:ListMedicalTranscriptionJobs'
, listMedicalTranscriptionJobs_jobNameContains
- When specified, the jobs returned in the list are limited to jobs whose
name contains the specified string.
$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 you specify, only
the actual results are returned. If you do not specify a value, the
default of 5 is used.
data ListMedicalTranscriptionJobsResponse Source #
See: newListMedicalTranscriptionJobsResponse
smart constructor.
ListMedicalTranscriptionJobsResponse' (Maybe TranscriptionJobStatus) (Maybe Text) (Maybe [MedicalTranscriptionJobSummary]) Int |
Instances
newListMedicalTranscriptionJobsResponse Source #
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:status:ListMedicalTranscriptionJobs'
, listMedicalTranscriptionJobsResponse_status
- The requested status of the medical transcription jobs returned.
$sel:nextToken:ListMedicalTranscriptionJobs'
, listMedicalTranscriptionJobsResponse_nextToken
- The ListMedicalTranscriptionJobs
operation returns a page of jobs at a
time. The maximum size of the page is set by the MaxResults
parameter.
If the number of jobs exceeds what can fit on a page, Amazon Transcribe
Medical returns the NextPage
token. Include the token in the next
request to the ListMedicalTranscriptionJobs
operation to return in the
next page of jobs.
$sel:medicalTranscriptionJobSummaries:ListMedicalTranscriptionJobsResponse'
, listMedicalTranscriptionJobsResponse_medicalTranscriptionJobSummaries
- A list of objects containing summary information for a transcription
job.
$sel:httpStatus:ListMedicalTranscriptionJobsResponse'
, listMedicalTranscriptionJobsResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of tag keys you want to remove from a specified Amazon Transcribe
resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
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.
DeleteVocabularyFilter
data DeleteVocabularyFilter Source #
See: newDeleteVocabularyFilter
smart constructor.
Instances
newDeleteVocabularyFilter Source #
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:
$sel:vocabularyFilterName:DeleteVocabularyFilter'
, deleteVocabularyFilter_vocabularyFilterName
- The name of the vocabulary filter to remove.
data DeleteVocabularyFilterResponse Source #
See: newDeleteVocabularyFilterResponse
smart constructor.
Instances
newDeleteVocabularyFilterResponse :: DeleteVocabularyFilterResponse Source #
Create a value of DeleteVocabularyFilterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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:nameContains:ListVocabularyFilters'
, listVocabularyFilters_nameContains
- Filters the response so that it only contains vocabulary filters whose
name contains the specified string.
$sel:nextToken:ListVocabularyFilters'
, listVocabularyFilters_nextToken
- If the result of the previous request to ListVocabularyFilters
was
truncated, include the NextToken
to fetch the next set of collections.
$sel:maxResults:ListVocabularyFilters'
, listVocabularyFilters_maxResults
- The maximum number of filters to return in each page of results. If
there are fewer results than the value you specify, only the actual
results are returned. If you do not specify a value, the default of 5 is
used.
data ListVocabularyFiltersResponse Source #
See: newListVocabularyFiltersResponse
smart constructor.
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:
$sel:nextToken:ListVocabularyFilters'
, listVocabularyFiltersResponse_nextToken
- The ListVocabularyFilters
operation returns a page of collections at a
time. The maximum size of the page is set by the MaxResults
parameter.
If there are more jobs in the list than the page size, Amazon Transcribe
returns the NextPage
token. Include the token in the next request to
the ListVocabularyFilters
operation to return in the next page of
jobs.
$sel:vocabularyFilters:ListVocabularyFiltersResponse'
, listVocabularyFiltersResponse_vocabularyFilters
- The list of vocabulary filters. It contains at most MaxResults
number
of filters. If there are more filters, call the ListVocabularyFilters
operation again with the NextToken
parameter in the request set to the
value of the NextToken
field in the response.
$sel:httpStatus:ListVocabularyFiltersResponse'
, listVocabularyFiltersResponse_httpStatus
- The response's http status code.
UpdateVocabularyFilter
data UpdateVocabularyFilter Source #
See: newUpdateVocabularyFilter
smart constructor.
Instances
newUpdateVocabularyFilter Source #
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 a text file used as input to create the
vocabulary filter. Only use characters from the character set defined
for custom vocabularies. For a list of character sets, see
Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the
VocabularyFilterFileUri
parameter, you can't use the Words
parameter.
$sel:words:UpdateVocabularyFilter'
, updateVocabularyFilter_words
- The words to use in the vocabulary filter. Only use characters from the
character set defined for custom vocabularies. For a list of character
sets, see
Character Sets for Custom Vocabularies.
If you provide a list of words in the Words
parameter, you can't use
the VocabularyFilterFileUri
parameter.
$sel:vocabularyFilterName:UpdateVocabularyFilter'
, updateVocabularyFilter_vocabularyFilterName
- The name of the vocabulary filter to update. If you try to update a
vocabulary filter with the same name as another vocabulary filter, you
get a ConflictException
error.
data UpdateVocabularyFilterResponse Source #
See: newUpdateVocabularyFilterResponse
smart constructor.
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:
$sel:languageCode:UpdateVocabularyFilterResponse'
, updateVocabularyFilterResponse_languageCode
- The language code of the words in the vocabulary filter.
$sel:lastModifiedTime:UpdateVocabularyFilterResponse'
, updateVocabularyFilterResponse_lastModifiedTime
- The date and time that the vocabulary filter was updated.
$sel:vocabularyFilterName:UpdateVocabularyFilter'
, updateVocabularyFilterResponse_vocabularyFilterName
- The name of the updated vocabulary filter.
$sel:httpStatus:UpdateVocabularyFilterResponse'
, updateVocabularyFilterResponse_httpStatus
- The response's http status code.
ListVocabularies
data ListVocabularies Source #
See: newListVocabularies
smart constructor.
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:nameContains:ListVocabularies'
, listVocabularies_nameContains
- When specified, the vocabularies returned in the list are limited to
vocabularies whose name contains the specified string. The search is not
case sensitive, ListVocabularies
returns both "vocabularyname" and
"VocabularyName" in the response list.
$sel:nextToken:ListVocabularies'
, listVocabularies_nextToken
- If the result of the previous request to ListVocabularies
was
truncated, include the NextToken
to fetch the next set of jobs.
$sel:stateEquals:ListVocabularies'
, listVocabularies_stateEquals
- When specified, only returns vocabularies with the VocabularyState
field equal to the specified state.
$sel:maxResults:ListVocabularies'
, listVocabularies_maxResults
- The maximum number of vocabularies to return in each page of results. If
there are fewer results than the value you specify, only the actual
results are returned. If you do not specify a value, the default of 5 is
used.
data ListVocabulariesResponse Source #
See: newListVocabulariesResponse
smart constructor.
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:
$sel:vocabularies:ListVocabulariesResponse'
, listVocabulariesResponse_vocabularies
- A list of objects that describe the vocabularies that match the search
criteria in the request.
$sel:status:ListVocabulariesResponse'
, listVocabulariesResponse_status
- The requested vocabulary state.
$sel:nextToken:ListVocabularies'
, listVocabulariesResponse_nextToken
- The ListVocabularies
operation returns a page of vocabularies at a
time. The maximum size of the page is set in the MaxResults
parameter.
If there are more jobs in the list than will fit on the page, Amazon
Transcribe returns the NextPage
token. To return in the next page of
jobs, include the token in the next request to the ListVocabularies
operation.
$sel:httpStatus:ListVocabulariesResponse'
, listVocabulariesResponse_httpStatus
- The response's http status code.
CreateVocabulary
data CreateVocabulary Source #
See: newCreateVocabulary
smart constructor.
CreateVocabulary' (Maybe Text) (Maybe [Text]) (Maybe (NonEmpty Tag)) Text LanguageCode |
Instances
:: 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:vocabularyFileUri:CreateVocabulary'
, createVocabulary_vocabularyFileUri
- The S3 location of the text file that contains the definition of the
custom vocabulary. The URI must be in the same region as the API
endpoint that you are calling. The general form is:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom vocabularies.
$sel:phrases:CreateVocabulary'
, createVocabulary_phrases
- An array of strings that contains the vocabulary entries.
$sel:tags:CreateVocabulary'
, createVocabulary_tags
- Adds one or more tags, each in the form of a key:value pair, to a new
Amazon Transcribe vocabulary at the time you create this new vocabulary.
$sel:vocabularyName:CreateVocabulary'
, createVocabulary_vocabularyName
- The name of the vocabulary. The name must be unique within an Amazon Web
Services account. The name is case sensitive. If you try to create a
vocabulary with the same name as a previous vocabulary you will receive
a ConflictException
error.
$sel:languageCode:CreateVocabulary'
, createVocabulary_languageCode
- The language code of the vocabulary entries. For a list of languages and
their corresponding language codes, see transcribe-whatis.
data CreateVocabularyResponse Source #
See: newCreateVocabularyResponse
smart constructor.
CreateVocabularyResponse' (Maybe Text) (Maybe LanguageCode) (Maybe Text) (Maybe POSIX) (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:
$sel:failureReason:CreateVocabularyResponse'
, createVocabularyResponse_failureReason
- If the VocabularyState
field is FAILED
, this field contains
information about why the job failed.
$sel:languageCode:CreateVocabulary'
, createVocabularyResponse_languageCode
- The language code of the vocabulary entries.
$sel:vocabularyName:CreateVocabulary'
, createVocabularyResponse_vocabularyName
- The name of the vocabulary.
$sel:lastModifiedTime:CreateVocabularyResponse'
, createVocabularyResponse_lastModifiedTime
- The date and time that the vocabulary was created.
$sel:vocabularyState:CreateVocabularyResponse'
, createVocabularyResponse_vocabularyState
- The processing state of the vocabulary. When the VocabularyState
field
contains READY
the vocabulary is ready to be used in a
StartTranscriptionJob
request.
$sel:httpStatus:CreateVocabularyResponse'
, createVocabularyResponse_httpStatus
- The response's http status code.
CreateLanguageModel
data CreateLanguageModel Source #
See: newCreateLanguageModel
smart constructor.
Instances
newCreateLanguageModel Source #
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:
$sel:tags:CreateLanguageModel'
, createLanguageModel_tags
- Adds one or more tags, each in the form of a key:value pair, to a new
language model at the time you create this new model.
$sel:languageCode:CreateLanguageModel'
, createLanguageModel_languageCode
- The language of the input text you're using to train your custom
language model.
$sel:baseModelName:CreateLanguageModel'
, createLanguageModel_baseModelName
- The Amazon Transcribe standard language model, or base model used to
create your custom language model.
If you want to use your custom language model to transcribe audio with a
sample rate of 16,000 Hz or greater, choose Wideband
.
If you want to use your custom language model to transcribe audio with a
sample rate that is less than 16,000 Hz, choose Narrowband
.
$sel:modelName:CreateLanguageModel'
, createLanguageModel_modelName
- The name you choose for your custom language model when you create it.
$sel:inputDataConfig:CreateLanguageModel'
, createLanguageModel_inputDataConfig
- Contains the data access role and the Amazon S3 prefixes to read the
required input files to create a custom language model.
data CreateLanguageModelResponse Source #
See: newCreateLanguageModelResponse
smart constructor.
CreateLanguageModelResponse' (Maybe CLMLanguageCode) (Maybe Text) (Maybe InputDataConfig) (Maybe BaseModelName) (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:
$sel:languageCode:CreateLanguageModel'
, createLanguageModelResponse_languageCode
- The language code of the text you've used to create a custom language
model.
$sel:modelName:CreateLanguageModel'
, createLanguageModelResponse_modelName
- The name you've chosen for your custom language model.
$sel:inputDataConfig:CreateLanguageModel'
, createLanguageModelResponse_inputDataConfig
- The data access role and Amazon S3 prefixes you've chosen to create
your custom language model.
$sel:baseModelName:CreateLanguageModel'
, createLanguageModelResponse_baseModelName
- The Amazon Transcribe standard language model, or base model you've
used to create a custom language model.
$sel:modelStatus:CreateLanguageModelResponse'
, createLanguageModelResponse_modelStatus
- The status of the custom language model. When the status is COMPLETED
the model is ready to use.
$sel:httpStatus:CreateLanguageModelResponse'
, createLanguageModelResponse_httpStatus
- The response's http status code.
StartTranscriptionJob
data StartTranscriptionJob Source #
See: newStartTranscriptionJob
smart constructor.
StartTranscriptionJob' (Maybe ContentRedaction) (Maybe Subtitles) (Maybe LanguageCode) (Maybe (NonEmpty LanguageCode)) (Maybe Settings) (Maybe Text) (Maybe MediaFormat) (Maybe Text) (Maybe ModelSettings) (Maybe (HashMap Text Text)) (Maybe JobExecutionSettings) (Maybe Text) (Maybe Bool) (Maybe (NonEmpty Tag)) (Maybe Natural) Text Media |
Instances
newStartTranscriptionJob Source #
:: 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:
$sel:contentRedaction:StartTranscriptionJob'
, startTranscriptionJob_contentRedaction
- An object that contains the request parameters for content redaction.
$sel:subtitles:StartTranscriptionJob'
, startTranscriptionJob_subtitles
- Add subtitles to your batch transcription job.
$sel:languageCode:StartTranscriptionJob'
, startTranscriptionJob_languageCode
- The language code for the language used in the input media file.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
$sel:languageOptions:StartTranscriptionJob'
, startTranscriptionJob_languageOptions
- An object containing a list of languages that might be present in your
collection of audio files. Automatic language identification chooses a
language that best matches the source audio from that list.
To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.
$sel:settings:StartTranscriptionJob'
, startTranscriptionJob_settings
- A Settings
object that provides optional settings for a transcription
job.
$sel:outputBucketName:StartTranscriptionJob'
, startTranscriptionJob_outputBucketName
- The location where the transcription is stored.
If you set the OutputBucketName
, Amazon Transcribe puts the transcript
in the specified S3 bucket. When you call the GetTranscriptionJob
operation, the operation returns this location in the
TranscriptFileUri
field. If you enable content redaction, the redacted
transcript appears in RedactedTranscriptFileUri
. If you enable content
redaction and choose to output an unredacted transcript, that
transcript's location still appears in the TranscriptFileUri
. The S3
bucket must have permissions that allow Amazon Transcribe to put files
in the bucket. For more information, see
Permissions Required for IAM User Roles.
You can specify an Amazon Web Services Key Management Service (KMS) key
to encrypt the output of your transcription using the
OutputEncryptionKMSKeyId
parameter. If you don't specify a KMS key,
Amazon Transcribe uses the default Amazon S3 key for server-side
encryption of transcripts that are placed in your S3 bucket.
If you don't set the OutputBucketName
, Amazon Transcribe generates a
pre-signed URL, a shareable URL that provides secure access to your
transcription, and returns it in the TranscriptFileUri
field. Use this
URL to download the transcription.
$sel:mediaFormat:StartTranscriptionJob'
, startTranscriptionJob_mediaFormat
- The format of the input media file.
$sel:outputEncryptionKMSKeyId:StartTranscriptionJob'
, startTranscriptionJob_outputEncryptionKMSKeyId
- The Amazon Resource Name (ARN) of the Amazon Web Services Key Management
Service (KMS) key used to encrypt the output of the transcription job.
The user calling the StartTranscriptionJob
operation must have
permission to use the specified KMS key.
You can use either of the following to identify a KMS key in the current account:
- KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
- KMS Key Alias: "alias/ExampleAlias"
You can use either of the following to identify a KMS key in the current account or another account:
- Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
If you don't specify an encryption key, the output of the transcription job 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 in the OutputBucketName
parameter.
$sel:modelSettings:StartTranscriptionJob'
, startTranscriptionJob_modelSettings
- Choose the custom language model you use for your transcription job in
this parameter.
$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.
$sel:jobExecutionSettings:StartTranscriptionJob'
, startTranscriptionJob_jobExecutionSettings
- Provides information about how a transcription job is executed. Use this
field to indicate that the job can be queued for deferred execution if
the concurrency limit is reached and there are no slots available to
immediately run the job.
$sel:outputKey:StartTranscriptionJob'
, startTranscriptionJob_outputKey
- You can specify a location in an Amazon S3 bucket to store the output of
your transcription job.
If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
If you specify an output key, you must also specify an S3 bucket in the
OutputBucketName
parameter.
$sel:identifyLanguage:StartTranscriptionJob'
, startTranscriptionJob_identifyLanguage
- Set this field to true
to enable automatic language identification.
Automatic language identification is disabled by default. You receive a
BadRequestException
error if you enter a value for a LanguageCode
.
$sel:tags:StartTranscriptionJob'
, startTranscriptionJob_tags
- Add tags to an Amazon Transcribe transcription job.
$sel:mediaSampleRateHertz:StartTranscriptionJob'
, startTranscriptionJob_mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in the input media file.
If you do not specify the media sample rate, Amazon Transcribe
determines the sample rate. If you specify the sample rate, it must
match the sample rate detected by Amazon Transcribe. In most cases, you
should leave the MediaSampleRateHertz
field blank and let Amazon
Transcribe determine the sample rate.
$sel:transcriptionJobName:StartTranscriptionJob'
, startTranscriptionJob_transcriptionJobName
- The name of the job. You can't use the strings ".
" or "..
" by
themselves as the job name. The name must also be unique within an
Amazon Web Services account. If you try to create a transcription job
with the same name as a previous transcription job, you get a
ConflictException
error.
$sel:media:StartTranscriptionJob'
, startTranscriptionJob_media
- An object that describes the input media for a transcription job.
data StartTranscriptionJobResponse Source #
See: newStartTranscriptionJobResponse
smart constructor.
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
- An object containing details of the asynchronous transcription job.
$sel:httpStatus:StartTranscriptionJobResponse'
, startTranscriptionJobResponse_httpStatus
- The response's http status code.
Types
BaseModelName
newtype BaseModelName Source #
pattern BaseModelName_NarrowBand :: BaseModelName | |
pattern BaseModelName_WideBand :: BaseModelName |
Instances
CLMLanguageCode
newtype CLMLanguageCode Source #
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 |
Instances
CallAnalyticsJobStatus
newtype CallAnalyticsJobStatus Source #
Instances
LanguageCode
newtype LanguageCode Source #
Instances
MediaFormat
newtype MediaFormat Source #
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 #
Instances
ModelStatus
newtype ModelStatus Source #
pattern ModelStatus_COMPLETED :: ModelStatus | |
pattern ModelStatus_FAILED :: ModelStatus | |
pattern ModelStatus_IN_PROGRESS :: ModelStatus |
Instances
OutputLocationType
newtype OutputLocationType Source #
pattern OutputLocationType_CUSTOMER_BUCKET :: OutputLocationType | |
pattern OutputLocationType_SERVICE_BUCKET :: OutputLocationType |
Instances
ParticipantRole
newtype ParticipantRole Source #
pattern ParticipantRole_AGENT :: ParticipantRole | |
pattern ParticipantRole_CUSTOMER :: ParticipantRole |
Instances
RedactionOutput
newtype RedactionOutput Source #
pattern RedactionOutput_Redacted :: RedactionOutput | |
pattern RedactionOutput_Redacted_and_unredacted :: RedactionOutput |
Instances
RedactionType
newtype RedactionType Source #
pattern RedactionType_PII :: RedactionType |
Instances
SentimentValue
newtype SentimentValue Source #
pattern SentimentValue_MIXED :: SentimentValue | |
pattern SentimentValue_NEGATIVE :: SentimentValue | |
pattern SentimentValue_NEUTRAL :: SentimentValue | |
pattern SentimentValue_POSITIVE :: SentimentValue |
Instances
Specialty
pattern Specialty_PRIMARYCARE :: Specialty |
Instances
SubtitleFormat
newtype SubtitleFormat Source #
pattern SubtitleFormat_Srt :: SubtitleFormat | |
pattern SubtitleFormat_Vtt :: SubtitleFormat |
Instances
TranscriptFilterType
newtype TranscriptFilterType Source #
pattern TranscriptFilterType_EXACT :: TranscriptFilterType |
Instances
TranscriptionJobStatus
newtype TranscriptionJobStatus Source #
Instances
Type
pattern Type_CONVERSATION :: Type | |
pattern Type_DICTATION :: Type |
Instances
VocabularyFilterMethod
newtype VocabularyFilterMethod Source #
pattern VocabularyFilterMethod_Mask :: VocabularyFilterMethod | |
pattern VocabularyFilterMethod_Remove :: VocabularyFilterMethod | |
pattern VocabularyFilterMethod_Tag :: VocabularyFilterMethod |
Instances
VocabularyState
newtype VocabularyState Source #
pattern VocabularyState_FAILED :: VocabularyState | |
pattern VocabularyState_PENDING :: VocabularyState | |
pattern VocabularyState_READY :: VocabularyState |
Instances
AbsoluteTimeRange
data AbsoluteTimeRange Source #
A time range, set in seconds, between two points in the call.
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:first:AbsoluteTimeRange'
, absoluteTimeRange_first
- A time range from the beginning of the call to the value that you've
specified. For example, if you specify 100000, the time range is set to
the first 100,000 milliseconds of the call.
$sel:startTime:AbsoluteTimeRange'
, absoluteTimeRange_startTime
- A value that indicates the beginning of the time range in seconds. To
set absolute time range, you must specify a start time and an end time.
For example, if you specify the following values:
- StartTime - 10000
- Endtime - 50000
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
$sel:last:AbsoluteTimeRange'
, absoluteTimeRange_last
- A time range from the value that you've specified to the end of the
call. For example, if you specify 100000, the time range is set to the
last 100,000 milliseconds of the call.
$sel:endTime:AbsoluteTimeRange'
, absoluteTimeRange_endTime
- A value that indicates the end of the time range in milliseconds. To set
absolute time range, you must specify a start time and an end time. For
example, if you specify the following values:
- StartTime - 10000
- Endtime - 50000
The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.
CallAnalyticsJob
data CallAnalyticsJob Source #
Describes an asynchronous analytics job that was created with the
StartAnalyticsJob
operation.
See: newCallAnalyticsJob
smart constructor.
CallAnalyticsJob' (Maybe POSIX) (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe Double) (Maybe LanguageCode) (Maybe CallAnalyticsJobSettings) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Media) (Maybe MediaFormat) (Maybe (NonEmpty ChannelDefinition)) (Maybe Text) (Maybe Transcript) (Maybe Natural) |
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:creationTime:CallAnalyticsJob'
, callAnalyticsJob_creationTime
- A timestamp that shows when the analytics job was created.
$sel:failureReason:CallAnalyticsJob'
, callAnalyticsJob_failureReason
- If the AnalyticsJobStatus
is FAILED
, this field contains information
about why the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
: The media format specified in theMediaFormat
field of the request isn't valid. See the description of theMediaFormat
field for a list of valid values.The media format provided does not match the detected media format
: The media format of the audio file doesn't match the format specified in theMediaFormat
field in the request. Check the media format of your media file and make sure the two values match.Invalid sample rate for audio file
: The sample rate specified in theMediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.The sample rate provided does not match the detected sample rate
: The sample rate in the audio file doesn't match the sample rate specified in theMediaSampleRateHertz
field in the request. Check the sample rate of your media file and make sure that the two values match.Invalid file size: file size too large
: The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical Guide.Invalid number of channels: number of channels too large
: Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference.
$sel:callAnalyticsJobStatus:CallAnalyticsJob'
, callAnalyticsJob_callAnalyticsJobStatus
- The status of the analytics job.
$sel:identifiedLanguageScore:CallAnalyticsJob'
, callAnalyticsJob_identifiedLanguageScore
- A value between zero and one that Amazon Transcribe assigned to the
language that it identified in the source audio. This value appears only
when you don't provide a single language code. Larger values indicate
that Amazon Transcribe has higher confidence in the language that it
identified
$sel:languageCode:CallAnalyticsJob'
, callAnalyticsJob_languageCode
- If you know the language spoken between the customer and the agent,
specify a language code for this field.
If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically identify the language. To improve the accuracy of language identification, you can provide an array containing the possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for additional information.
$sel:settings:CallAnalyticsJob'
, callAnalyticsJob_settings
- Provides information about the settings used to run a transcription job.
$sel:startTime:CallAnalyticsJob'
, callAnalyticsJob_startTime
- A timestamp that shows when the analytics job started processing.
$sel:completionTime:CallAnalyticsJob'
, callAnalyticsJob_completionTime
- A timestamp that shows when the analytics job was completed.
$sel:callAnalyticsJobName:CallAnalyticsJob'
, callAnalyticsJob_callAnalyticsJobName
- The name of the call analytics job.
$sel:media:CallAnalyticsJob'
, callAnalyticsJob_media
- Undocumented member.
$sel:mediaFormat:CallAnalyticsJob'
, callAnalyticsJob_mediaFormat
- The format of the input audio file. Note: for call analytics jobs, only
the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and
WebM.
$sel:channelDefinitions:CallAnalyticsJob'
, callAnalyticsJob_channelDefinitions
- Shows numeric values to indicate the channel assigned to the agent's
audio and the channel assigned to the customer's audio.
$sel:dataAccessRoleArn:CallAnalyticsJob'
, callAnalyticsJob_dataAccessRoleArn
- The Amazon Resource Number (ARN) that you use to get access to the
analytics job.
$sel:transcript:CallAnalyticsJob'
, callAnalyticsJob_transcript
- Undocumented member.
$sel:mediaSampleRateHertz:CallAnalyticsJob'
, callAnalyticsJob_mediaSampleRateHertz
- The sample rate, in Hertz, of the audio.
CallAnalyticsJobSettings
data CallAnalyticsJobSettings Source #
Provides optional settings for the CallAnalyticsJob
operation.
See: newCallAnalyticsJobSettings
smart constructor.
CallAnalyticsJobSettings' (Maybe ContentRedaction) (Maybe (NonEmpty LanguageCode)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VocabularyFilterMethod) |
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:languageOptions:CallAnalyticsJobSettings'
, callAnalyticsJobSettings_languageOptions
- When you run a call analytics job, you can specify the language spoken
in the audio, or you can have Amazon Transcribe identify the language
for you.
To specify a language, specify an array with one language code. If you don't know the language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to Supported languages and language-specific features for additional information.
$sel:vocabularyName:CallAnalyticsJobSettings'
, callAnalyticsJobSettings_vocabularyName
- The name of a vocabulary to use when processing the call analytics job.
$sel:languageModelName:CallAnalyticsJobSettings'
, callAnalyticsJobSettings_languageModelName
- The structure used to describe a custom language model.
$sel:vocabularyFilterName:CallAnalyticsJobSettings'
, callAnalyticsJobSettings_vocabularyFilterName
- The name of the vocabulary filter to use when running a call analytics
job. The filter that you specify must have the same language code as the
analytics job.
$sel:vocabularyFilterMethod:CallAnalyticsJobSettings'
, callAnalyticsJobSettings_vocabularyFilterMethod
- Set to mask to remove filtered text from the transcript and replace it
with three asterisks ("***") as placeholder text. Set to remove
to
remove filtered text from the transcript without using placeholder text.
Set to tag
to mark the word in the transcription output that matches
the vocabulary filter. When you set the filter method to tag
, the
words matching your vocabulary filter are not masked or removed.
CallAnalyticsJobSummary
data CallAnalyticsJobSummary Source #
Provides summary information about a call analytics job.
See: newCallAnalyticsJobSummary
smart constructor.
CallAnalyticsJobSummary' (Maybe POSIX) (Maybe Text) (Maybe CallAnalyticsJobStatus) (Maybe LanguageCode) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
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:creationTime:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_creationTime
- A timestamp that shows when the call analytics job was created.
$sel:failureReason:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_failureReason
- If the CallAnalyticsJobStatus
is FAILED
, a description of the error.
$sel:callAnalyticsJobStatus:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_callAnalyticsJobStatus
- The status of the call analytics job.
$sel:languageCode:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_languageCode
- The language of the transcript in the source audio file.
$sel:startTime:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_startTime
- A timestamp that shows when the job began processing.
$sel:completionTime:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_completionTime
- A timestamp that shows when the job was completed.
$sel:callAnalyticsJobName:CallAnalyticsJobSummary'
, callAnalyticsJobSummary_callAnalyticsJobName
- The name of the call analytics job.
CategoryProperties
data CategoryProperties Source #
An object that contains the rules and additional information about a call analytics category.
See: newCategoryProperties
smart constructor.
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:rules:CategoryProperties'
, categoryProperties_rules
- The rules used to create a call analytics category.
$sel:categoryName:CategoryProperties'
, categoryProperties_categoryName
- The name of the call analytics category.
$sel:lastUpdateTime:CategoryProperties'
, categoryProperties_lastUpdateTime
- A timestamp that shows when the call analytics category was most
recently updated.
$sel:createTime:CategoryProperties'
, categoryProperties_createTime
- A timestamp that shows when the call analytics category was created.
ChannelDefinition
data ChannelDefinition Source #
For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio channel that belongs to the customer.
See: newChannelDefinition
smart constructor.
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:participantRole:ChannelDefinition'
, channelDefinition_participantRole
- Indicates whether the person speaking on the audio channel is the agent
or customer.
$sel:channelId:ChannelDefinition'
, channelDefinition_channelId
- A value that indicates the audio channel.
ContentRedaction
data ContentRedaction Source #
Settings for content redaction within a transcription job.
See: newContentRedaction
smart constructor.
Instances
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:redactionType:ContentRedaction'
, contentRedaction_redactionType
- Request parameter that defines the entities to be redacted. The only
accepted value is PII
.
$sel:redactionOutput:ContentRedaction'
, contentRedaction_redactionOutput
- The output transcript file stored in either the default S3 bucket or in
a bucket you specify.
When you choose redacted
Amazon Transcribe outputs only the redacted
transcript.
When you choose redacted_and_unredacted
Amazon Transcribe outputs both
the redacted and unredacted transcripts.
InputDataConfig
data InputDataConfig Source #
The object that contains the Amazon S3 object location and access role required to train and tune your custom language model.
See: newInputDataConfig
smart constructor.
Instances
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 prefix you specify to access the plain text files that you
use to tune your custom language model.
$sel:s3Uri:InputDataConfig'
, inputDataConfig_s3Uri
- The Amazon S3 prefix you specify to access the plain text files that you
use to train your custom language model.
$sel:dataAccessRoleArn:InputDataConfig'
, inputDataConfig_dataAccessRoleArn
- The Amazon Resource Name (ARN) that uniquely identifies the permissions
you've given Amazon Transcribe to access your Amazon S3 buckets
containing your media files or text data.
InterruptionFilter
data InterruptionFilter Source #
An object that enables you to configure your category to be applied to call analytics jobs where either the customer or agent was interrupted.
See: newInterruptionFilter
smart constructor.
InterruptionFilter' (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Bool) (Maybe Natural) (Maybe AbsoluteTimeRange) |
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:participantRole:InterruptionFilter'
, interruptionFilter_participantRole
- Indicates whether the caller or customer was interrupting.
$sel:relativeTimeRange:InterruptionFilter'
, interruptionFilter_relativeTimeRange
- An object that allows percentages to specify the proportion of the call
where there was a interruption. For example, you can specify the first
half of the call. You can also specify the period of time between
halfway through to three-quarters of the way through the call. Because
the length of conversation can vary between calls, you can apply
relative time ranges across all calls.
$sel:negate:InterruptionFilter'
, interruptionFilter_negate
- Set to TRUE
to look for a time period where there was no interruption.
$sel:threshold:InterruptionFilter'
, interruptionFilter_threshold
- The duration of the interruption.
$sel:absoluteTimeRange:InterruptionFilter'
, interruptionFilter_absoluteTimeRange
- An object you can use to specify a time range (in milliseconds) for when
you'd want to find the interruption. For example, you could search for
an interruption between the 30,000 millisecond mark and the 45,000
millisecond mark. You could also specify the time period as the first
15,000 milliseconds or the last 15,000 milliseconds.
JobExecutionSettings
data JobExecutionSettings Source #
Provides information about when a transcription job should be executed.
See: newJobExecutionSettings
smart constructor.
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:dataAccessRoleArn:JobExecutionSettings'
, jobExecutionSettings_dataAccessRoleArn
- The Amazon Resource Name (ARN) of a role that has access to the S3
bucket that contains the input files. Amazon Transcribe assumes this
role to read queued media files. If you have specified an output S3
bucket for the transcription results, this role should have access to
the output bucket as well.
If you specify the AllowDeferredExecution
field, you must specify the
DataAccessRoleArn
field.
$sel:allowDeferredExecution:JobExecutionSettings'
, jobExecutionSettings_allowDeferredExecution
- Indicates whether a job should be queued by Amazon Transcribe when the
concurrent execution limit is exceeded. When the
AllowDeferredExecution
field is true, jobs are queued and executed
when the number of executing jobs falls below the concurrent execution
limit. If the field is false, Amazon Transcribe returns a
LimitExceededException
exception.
Note that job queuing is enabled by default for call analytics jobs.
If you specify the AllowDeferredExecution
field, you must specify the
DataAccessRoleArn
field.
LanguageModel
data LanguageModel Source #
The structure used to describe a custom language model.
See: newLanguageModel
smart constructor.
LanguageModel' (Maybe Text) (Maybe CLMLanguageCode) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe InputDataConfig) (Maybe BaseModelName) (Maybe ModelStatus) (Maybe POSIX) |
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:failureReason:LanguageModel'
, languageModel_failureReason
- The reason why the custom language model couldn't be created.
$sel:languageCode:LanguageModel'
, languageModel_languageCode
- The language code you used to create your custom language model.
$sel:modelName:LanguageModel'
, languageModel_modelName
- The name of the custom language model.
$sel:lastModifiedTime:LanguageModel'
, languageModel_lastModifiedTime
- The most recent time the custom language model was modified.
$sel:upgradeAvailability:LanguageModel'
, languageModel_upgradeAvailability
- Whether the base model used for the custom language model is up to date.
If this field is true
then you are running the most up-to-date version
of the base model in your custom language model.
$sel:inputDataConfig:LanguageModel'
, languageModel_inputDataConfig
- The data access role and Amazon S3 prefixes for the input files used to
train the custom language model.
$sel:baseModelName:LanguageModel'
, languageModel_baseModelName
- The Amazon Transcribe standard language model, or base model used to
create the custom language model.
$sel:modelStatus:LanguageModel'
, languageModel_modelStatus
- The creation status of a custom language model. When the status is
COMPLETED
the model is ready for use.
$sel:createTime:LanguageModel'
, languageModel_createTime
- The time the custom language model was created.
Media
Describes the input media file in a transcription request.
See: newMedia
smart constructor.
Instances
Eq Media Source # | |
Read Media Source # | |
Show Media Source # | |
Generic Media Source # | |
NFData Media Source # | |
Defined in Amazonka.Transcribe.Types.Media | |
Hashable Media Source # | |
Defined in Amazonka.Transcribe.Types.Media | |
ToJSON Media Source # | |
Defined in Amazonka.Transcribe.Types.Media | |
FromJSON Media Source # | |
type Rep Media Source # | |
Defined in Amazonka.Transcribe.Types.Media type Rep Media = D1 ('MetaData "Media" "Amazonka.Transcribe.Types.Media" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" '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 S3 object location of the input media file. The URI must be in the
same region as the API endpoint that you are calling. The general form
is:
For example:
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
$sel:redactedMediaFileUri:Media'
, media_redactedMediaFileUri
- The S3 object location for your redacted output media file. This is only
supported for call analytics jobs.
MedicalTranscript
data MedicalTranscript Source #
Identifies the location of a medical transcript.
See: newMedicalTranscript
smart constructor.
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 S3 object location of the medical transcript.
Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
MedicalTranscriptionJob
data MedicalTranscriptionJob Source #
The data structure that contains the information for a medical transcription job.
See: newMedicalTranscriptionJob
smart constructor.
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:creationTime:MedicalTranscriptionJob'
, medicalTranscriptionJob_creationTime
- A timestamp that shows when the job was created.
$sel:specialty:MedicalTranscriptionJob'
, medicalTranscriptionJob_specialty
- The medical specialty of any clinicians providing a dictation or having
a conversation. Refer to
Transcribing a medical conversationfor
a list of supported specialties.
$sel:failureReason:MedicalTranscriptionJob'
, medicalTranscriptionJob_failureReason
- If the TranscriptionJobStatus
field is FAILED
, this field contains
information about why the job failed.
The FailureReason
field contains one of the following values:
Unsupported media format
- The media format specified in theMediaFormat
field of the request isn't valid. See the description of theMediaFormat
field for a list of valid values.The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format specified in theMediaFormat
field in the request. Check the media format of your media file and make sure the two values match.Invalid sample rate for audio file
- The sample rate specified in theMediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate specified in theMediaSampleRateHertz
field in the request. Check the sample rate of your media file and make sure that the two values match.Invalid file size: file size too large
- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidelines and Quotas in the Amazon Transcribe Medical GuideInvalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference
$sel:languageCode:MedicalTranscriptionJob'
, medicalTranscriptionJob_languageCode
- The language code for the language spoken in the source audio file. US
English (en-US) is the only supported language for medical
transcriptions. Any other value you enter for language code results in a
BadRequestException
error.
$sel:settings:MedicalTranscriptionJob'
, medicalTranscriptionJob_settings
- Object that contains object.
$sel:startTime:MedicalTranscriptionJob'
, medicalTranscriptionJob_startTime
- A timestamp that shows when the job started processing.
$sel:completionTime:MedicalTranscriptionJob'
, medicalTranscriptionJob_completionTime
- A timestamp that shows when the job was completed.
$sel:media:MedicalTranscriptionJob'
, medicalTranscriptionJob_media
- Undocumented member.
$sel:mediaFormat:MedicalTranscriptionJob'
, medicalTranscriptionJob_mediaFormat
- The format of the input media file.
$sel:medicalTranscriptionJobName:MedicalTranscriptionJob'
, medicalTranscriptionJob_medicalTranscriptionJobName
- The name for a given medical transcription job.
$sel:transcriptionJobStatus:MedicalTranscriptionJob'
, medicalTranscriptionJob_transcriptionJobStatus
- The completion status of a medical transcription job.
$sel:type':MedicalTranscriptionJob'
, medicalTranscriptionJob_type
- The type of speech in the transcription job. CONVERSATION
is generally
used for patient-physician dialogues. DICTATION
is the setting for
physicians speaking their notes after seeing a patient. For more
information, see
What is Amazon Transcribe Medical?.
$sel:contentIdentificationType:MedicalTranscriptionJob'
, medicalTranscriptionJob_contentIdentificationType
- Shows the type of content that you've configured Amazon Transcribe
Medical to identify in a transcription job. If the value is PHI
,
you've configured the job to identify personal health information (PHI)
in the transcription output.
$sel:transcript:MedicalTranscriptionJob'
, medicalTranscriptionJob_transcript
- An object that contains the MedicalTranscript
. The MedicalTranscript
contains the TranscriptFileUri
.
$sel:tags:MedicalTranscriptionJob'
, medicalTranscriptionJob_tags
- A key:value pair assigned to a given medical transcription job.
$sel:mediaSampleRateHertz:MedicalTranscriptionJob'
, medicalTranscriptionJob_mediaSampleRateHertz
- The sample rate, in Hertz, of the source audio containing medical
information.
If you don't specify the sample rate, Amazon Transcribe Medical
determines it for you. If you choose to specify the sample rate, it must
match the rate detected by Amazon Transcribe Medical. In most cases, you
should leave the MedicalMediaSampleHertz
blank and let Amazon
Transcribe Medical determine the sample rate.
MedicalTranscriptionJobSummary
data MedicalTranscriptionJobSummary Source #
Provides summary information about a transcription job.
See: newMedicalTranscriptionJobSummary
smart constructor.
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:creationTime:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_creationTime
- A timestamp that shows when the medical transcription job was created.
$sel:specialty:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_specialty
- The medical specialty of the transcription job. Refer to
Transcribing a medical conversationfor
a list of supported specialties.
$sel:failureReason:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_failureReason
- If the TranscriptionJobStatus
field is FAILED
, a description of the
error.
$sel:languageCode:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_languageCode
- The language of the transcript in the source audio file.
$sel:outputLocationType:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_outputLocationType
- Indicates the location of the transcription job's output. This field
must be the path of an S3 bucket; if you don't already have an S3
bucket, one is created based on the path you add.
$sel:startTime:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_startTime
- A timestamp that shows when the job began processing.
$sel:completionTime:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_completionTime
- A timestamp that shows when the job was completed.
$sel:medicalTranscriptionJobName:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_medicalTranscriptionJobName
- The name of a medical transcription job.
$sel:transcriptionJobStatus:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_transcriptionJobStatus
- The status of the medical transcription job.
$sel:type':MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_type
- The speech of the clinician in the input audio.
$sel:contentIdentificationType:MedicalTranscriptionJobSummary'
, medicalTranscriptionJobSummary_contentIdentificationType
- Shows the type of information you've configured Amazon Transcribe
Medical to identify in a transcription job. If the value is PHI
,
you've configured the transcription job to identify personal health
information (PHI).
MedicalTranscriptionSetting
data MedicalTranscriptionSetting Source #
Optional settings for the StartMedicalTranscriptionJob operation.
See: newMedicalTranscriptionSetting
smart constructor.
MedicalTranscriptionSetting' (Maybe Text) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Bool) |
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:vocabularyName:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_vocabularyName
- The name of the vocabulary to use when processing a medical
transcription job.
$sel:maxAlternatives:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_maxAlternatives
- The maximum number of alternatives that you tell the service to return.
If you specify the MaxAlternatives
field, you must set the
ShowAlternatives
field to true.
$sel:channelIdentification:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_channelIdentification
- Instructs Amazon Transcribe Medical to process each audio channel
separately and then merge the transcription output of each channel into
a single transcription.
Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical.
You can't set both ShowSpeakerLabels
and ChannelIdentification
in
the same request. If you set both, your request returns a
BadRequestException
$sel:showAlternatives:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_showAlternatives
- Determines whether alternative transcripts are generated along with the
transcript that has the highest confidence. If you set
ShowAlternatives
field to true, you must also set the maximum number
of alternatives to return in the MaxAlternatives
field.
$sel:maxSpeakerLabels:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_maxSpeakerLabels
- The maximum number of speakers to identify in the input audio. If there
are more speakers in the audio than this number, multiple speakers are
identified as a single speaker. If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels
field to true.
$sel:showSpeakerLabels:MedicalTranscriptionSetting'
, medicalTranscriptionSetting_showSpeakerLabels
- Determines whether the transcription job uses speaker recognition to
identify different speakers in the input audio. Speaker recognition
labels individual speakers in the audio file. If you set the
ShowSpeakerLabels
field to true, you must also set the maximum number
of speaker labels in the MaxSpeakerLabels
field.
You can't set both ShowSpeakerLabels
and ChannelIdentification
in
the same request. If you set both, your request returns a
BadRequestException
.
ModelSettings
data ModelSettings Source #
The object used to call your custom language model to your transcription job.
See: newModelSettings
smart constructor.
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 your custom language model.
NonTalkTimeFilter
data NonTalkTimeFilter Source #
An object that enables you to configure your category to be applied to call analytics jobs where either the customer or agent was interrupted.
See: newNonTalkTimeFilter
smart constructor.
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:relativeTimeRange:NonTalkTimeFilter'
, nonTalkTimeFilter_relativeTimeRange
- An object that allows percentages to specify the proportion of the call
where there was silence. For example, you can specify the first half of
the call. You can also specify the period of time between halfway
through to three-quarters of the way through the call. Because the
length of conversation can vary between calls, you can apply relative
time ranges across all calls.
$sel:negate:NonTalkTimeFilter'
, nonTalkTimeFilter_negate
- Set to TRUE
to look for a time period when people were talking.
$sel:threshold:NonTalkTimeFilter'
, nonTalkTimeFilter_threshold
- The duration of the period when neither the customer nor agent was
talking.
$sel:absoluteTimeRange:NonTalkTimeFilter'
, nonTalkTimeFilter_absoluteTimeRange
- An object you can use to specify a time range (in milliseconds) for when
no one is talking. For example, you could specify a time period between
the 30,000 millisecond mark and the 45,000 millisecond mark. You could
also specify the time period as the first 15,000 milliseconds or the
last 15,000 milliseconds.
RelativeTimeRange
data RelativeTimeRange Source #
An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For example, you can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply relative time ranges across all calls.
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
- A value that indicates the percentage of the end of the time range. To
set a relative time range, you must specify a start percentage and an
end percentage. For example, if you specify the following values:
- StartPercentage - 10
- EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
$sel:first:RelativeTimeRange'
, relativeTimeRange_first
- A range that takes the portion of the call up to the time in
milliseconds set by the value that you've specified. For example, if
you specify 120000
, the time range is set for the first 120,000
milliseconds of the call.
$sel:last:RelativeTimeRange'
, relativeTimeRange_last
- A range that takes the portion of the call from the time in milliseconds
set by the value that you've specified to the end of the call. For
example, if you specify 120000
, the time range is set for the last
120,000 milliseconds of the call.
$sel:startPercentage:RelativeTimeRange'
, relativeTimeRange_startPercentage
- A value that indicates the percentage of the beginning of the time
range. To set a relative time range, you must specify a start percentage
and an end percentage. For example, if you specify the following values:
- StartPercentage - 10
- EndPercentage - 50
This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 millisecond mark.
Rule
A condition in the call between the customer and the agent that you want to filter for.
See: newRule
smart constructor.
Rule' (Maybe NonTalkTimeFilter) (Maybe TranscriptFilter) (Maybe SentimentFilter) (Maybe InterruptionFilter) |
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:nonTalkTimeFilter:Rule'
, rule_nonTalkTimeFilter
- A condition for a time period when neither the customer nor the agent
was talking.
$sel:transcriptFilter:Rule'
, rule_transcriptFilter
- A condition that catches particular words or phrases based on a exact
match. For example, if you set the phrase "I want to speak to the
manager", only that exact phrase will be returned.
$sel:sentimentFilter:Rule'
, rule_sentimentFilter
- A condition that is applied to a particular customer sentiment.
$sel:interruptionFilter:Rule'
, rule_interruptionFilter
- A condition for a time period when either the customer or agent was
interrupting the other person.
SentimentFilter
data SentimentFilter Source #
An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.
See: newSentimentFilter
smart constructor.
SentimentFilter' (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Bool) (Maybe AbsoluteTimeRange) (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:participantRole:SentimentFilter'
, sentimentFilter_participantRole
- A value that determines whether the sentiment belongs to the customer or
the agent.
$sel:relativeTimeRange:SentimentFilter'
, sentimentFilter_relativeTimeRange
- The time range, set in percentages, that correspond to proportion of the
call.
$sel:negate:SentimentFilter'
, sentimentFilter_negate
- Set to TRUE
to look for sentiments that weren't specified in the
request.
$sel:absoluteTimeRange:SentimentFilter'
, sentimentFilter_absoluteTimeRange
- The time range, measured in seconds, of the sentiment.
$sel:sentiments:SentimentFilter'
, sentimentFilter_sentiments
- An array that enables you to specify sentiments for the customer or
agent. You can specify one or more values.
Settings
Provides optional settings for the StartTranscriptionJob
operation.
See: newSettings
smart constructor.
Settings' (Maybe Text) (Maybe Natural) (Maybe Bool) (Maybe Bool) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe VocabularyFilterMethod) |
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:vocabularyName:Settings'
, settings_vocabularyName
- The name of a vocabulary to use when processing the transcription job.
$sel:maxAlternatives:Settings'
, settings_maxAlternatives
- The number of alternative transcriptions that the service should return.
If you specify the MaxAlternatives
field, you must set the
ShowAlternatives
field to true.
$sel:channelIdentification:Settings'
, settings_channelIdentification
- Instructs Amazon Transcribe to process each audio channel separately and
then merge the transcription output of each channel into a single
transcription.
Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.
You can't set both ShowSpeakerLabels
and ChannelIdentification
in
the same request. If you set both, your request returns a
BadRequestException
.
$sel:showAlternatives:Settings'
, settings_showAlternatives
- Determines whether the transcription contains alternative
transcriptions. If you set the ShowAlternatives
field to true, you
must also set the maximum number of alternatives to return in the
MaxAlternatives
field.
$sel:maxSpeakerLabels:Settings'
, settings_maxSpeakerLabels
- The maximum number of speakers to identify in the input audio. If there
are more speakers in the audio than this number, multiple speakers are
identified as a single speaker. If you specify the MaxSpeakerLabels
field, you must set the ShowSpeakerLabels
field to true.
$sel:vocabularyFilterName:Settings'
, settings_vocabularyFilterName
- The name of the vocabulary filter to use when transcribing the audio.
The filter that you specify must have the same language code as the
transcription job.
$sel:showSpeakerLabels:Settings'
, settings_showSpeakerLabels
- Determines whether the transcription job uses speaker recognition to
identify different speakers in the input audio. Speaker recognition
labels individual speakers in the audio file. If you set the
ShowSpeakerLabels
field to true, you must also set the maximum number
of speaker labels MaxSpeakerLabels
field.
You can't set both ShowSpeakerLabels
and ChannelIdentification
in
the same request. If you set both, your request returns a
BadRequestException
.
$sel:vocabularyFilterMethod:Settings'
, settings_vocabularyFilterMethod
- Set to mask
to remove filtered text from the transcript and replace it
with three asterisks ("***") as placeholder text. Set to remove
to
remove filtered text from the transcript without using placeholder text.
Set to tag
to mark the word in the transcription output that matches
the vocabulary filter. When you set the filter method to tag
, the
words matching your vocabulary filter are not masked or removed.
Subtitles
Generate subtitles for your batch transcription job.
See: newSubtitles
smart constructor.
Instances
Eq Subtitles Source # | |
Read Subtitles Source # | |
Show Subtitles Source # | |
Generic Subtitles Source # | |
NFData Subtitles Source # | |
Defined in Amazonka.Transcribe.Types.Subtitles | |
Hashable Subtitles Source # | |
Defined in Amazonka.Transcribe.Types.Subtitles | |
ToJSON 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" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "Subtitles'" 'PrefixI 'True) (S1 ('MetaSel ('Just "formats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubtitleFormat])))) |
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.
SubtitlesOutput
data SubtitlesOutput Source #
Specify the output format for your subtitle file.
See: newSubtitlesOutput
smart constructor.
SubtitlesOutput' (Maybe [SubtitleFormat]) (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
- Specify the output format for your subtitle file; if you select both SRT
and VTT formats, two output files are genereated.
$sel:subtitleFileUris:SubtitlesOutput'
, subtitlesOutput_subtitleFileUris
- Choose the output location for your subtitle file. This location must be
an S3 bucket.
Tag
A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.Transcribe.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Transcribe.Types.Tag" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" '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'.
Transcript
data Transcript Source #
Identifies the location of a transcription.
See: newTranscript
smart constructor.
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 S3 object location of the redacted transcript.
Use this URI to access the redacted transcript. If you specified an S3
bucket in the OutputBucketName
field when you created the job, this is
the URI of that bucket. If you chose to store the transcript in Amazon
Transcribe, this is a shareable URL that provides secure access to that
location.
$sel:transcriptFileUri:Transcript'
, transcript_transcriptFileUri
- The S3 object location of the transcript.
Use this URI to access the transcript. If you specified an S3 bucket in
the OutputBucketName
field when you created the job, this is the URI
of that bucket. If you chose to store the transcript in Amazon
Transcribe, this is a shareable URL that provides secure access to that
location.
TranscriptFilter
data TranscriptFilter Source #
Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases that you specify.
See: newTranscriptFilter
smart constructor.
TranscriptFilter' (Maybe ParticipantRole) (Maybe RelativeTimeRange) (Maybe Bool) (Maybe AbsoluteTimeRange) TranscriptFilterType (NonEmpty Text) |
Instances
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:participantRole:TranscriptFilter'
, transcriptFilter_participantRole
- Determines whether the customer or the agent is speaking the phrases
that you've specified.
$sel:relativeTimeRange:TranscriptFilter'
, transcriptFilter_relativeTimeRange
- An object that allows percentages to specify the proportion of the call
where you would like to apply a filter. For example, you can specify the
first half of the call. You can also specify the period of time between
halfway through to three-quarters of the way through the call. Because
the length of conversation can vary between calls, you can apply
relative time ranges across all calls.
$sel:negate:TranscriptFilter'
, transcriptFilter_negate
- If TRUE
, the rule that you specify is applied to everything except for
the phrases that you specify.
$sel:absoluteTimeRange:TranscriptFilter'
, transcriptFilter_absoluteTimeRange
- A time range, set in seconds, between two points in the call.
$sel:transcriptFilterType:TranscriptFilter'
, transcriptFilter_transcriptFilterType
- Matches the phrase to the transcription output in a word for word
fashion. For example, if you specify the phrase "I want to speak to the
manager." Amazon Transcribe attempts to match that specific phrase to
the transcription.
$sel:targets:TranscriptFilter'
, transcriptFilter_targets
- The phrases that you're specifying for the transcript filter to match.
TranscriptionJob
data TranscriptionJob Source #
Describes an asynchronous transcription job that was created with the
StartTranscriptionJob
operation.
See: newTranscriptionJob
smart constructor.
TranscriptionJob' (Maybe POSIX) (Maybe Text) (Maybe ContentRedaction) (Maybe Double) (Maybe SubtitlesOutput) (Maybe LanguageCode) (Maybe (NonEmpty LanguageCode)) (Maybe Settings) (Maybe POSIX) (Maybe POSIX) (Maybe Media) (Maybe MediaFormat) (Maybe ModelSettings) (Maybe TranscriptionJobStatus) (Maybe JobExecutionSettings) (Maybe Text) (Maybe Bool) (Maybe Transcript) (Maybe (NonEmpty Tag)) (Maybe Natural) |
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:creationTime:TranscriptionJob'
, transcriptionJob_creationTime
- A timestamp that shows when the job was created.
$sel:failureReason:TranscriptionJob'
, transcriptionJob_failureReason
- If the TranscriptionJobStatus
field is FAILED
, this field contains
information about why the job failed.
The FailureReason
field can contain one of the following values:
Unsupported media format
- The media format specified in theMediaFormat
field of the request isn't valid. See the description of theMediaFormat
field for a list of valid values.The media format provided does not match the detected media format
- The media format of the audio file doesn't match the format
specified in the
MediaFormat
field in the request. Check the media format of your media file and make sure that the two values match. Invalid sample rate for audio file
- The sample rate specified in theMediaSampleRateHertz
of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.The sample rate provided does not match the detected sample rate
- The sample rate in the audio file doesn't match the sample rate specified in theMediaSampleRateHertz
field in the request. Check the sample rate of your media file and make sure that the two values match.Invalid file size: file size too large
- The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.Invalid number of channels: number of channels too large
- Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
$sel:contentRedaction:TranscriptionJob'
, transcriptionJob_contentRedaction
- An object that describes content redaction settings for the
transcription job.
$sel:identifiedLanguageScore:TranscriptionJob'
, transcriptionJob_identifiedLanguageScore
- A value between zero and one that Amazon Transcribe assigned to the
language that it identified in the source audio. Larger values indicate
that Amazon Transcribe has higher confidence in the language it
identified.
$sel:subtitles:TranscriptionJob'
, transcriptionJob_subtitles
- Generate subtitles for your batch transcription job.
$sel:languageCode:TranscriptionJob'
, transcriptionJob_languageCode
- The language code for the input speech.
$sel:languageOptions:TranscriptionJob'
, transcriptionJob_languageOptions
- An object that shows the optional array of languages inputted for
transcription jobs with automatic language identification enabled.
$sel:settings:TranscriptionJob'
, transcriptionJob_settings
- Optional settings for the transcription job. Use these settings to turn
on speaker recognition, to set the maximum number of speakers that
should be identified and to specify a custom vocabulary to use when
processing the transcription job.
$sel:startTime:TranscriptionJob'
, transcriptionJob_startTime
- A timestamp that shows when the job started processing.
$sel:completionTime:TranscriptionJob'
, transcriptionJob_completionTime
- A timestamp that shows when the job completed.
$sel:media:TranscriptionJob'
, transcriptionJob_media
- An object that describes the input media for the transcription job.
$sel:mediaFormat:TranscriptionJob'
, transcriptionJob_mediaFormat
- The format of the input media file.
$sel:modelSettings:TranscriptionJob'
, transcriptionJob_modelSettings
- An object containing the details of your custom language model.
$sel:transcriptionJobStatus:TranscriptionJob'
, transcriptionJob_transcriptionJobStatus
- The status of the transcription job.
$sel:jobExecutionSettings:TranscriptionJob'
, transcriptionJob_jobExecutionSettings
- Provides information about how a transcription job is executed.
$sel:transcriptionJobName:TranscriptionJob'
, transcriptionJob_transcriptionJobName
- The name of the transcription job.
$sel:identifyLanguage:TranscriptionJob'
, transcriptionJob_identifyLanguage
- A value that shows if automatic language identification was enabled for
a transcription job.
$sel:transcript:TranscriptionJob'
, transcriptionJob_transcript
- An object that describes the output of the transcription job.
$sel:tags:TranscriptionJob'
, transcriptionJob_tags
- A key:value pair assigned to a given transcription job.
$sel:mediaSampleRateHertz:TranscriptionJob'
, transcriptionJob_mediaSampleRateHertz
- The sample rate, in Hertz, of the audio track in the input media file.
TranscriptionJobSummary
data TranscriptionJobSummary Source #
Provides a summary of information about a transcription job.
See: newTranscriptionJobSummary
smart constructor.
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:creationTime:TranscriptionJobSummary'
, transcriptionJobSummary_creationTime
- A timestamp that shows when the job was created.
$sel:failureReason:TranscriptionJobSummary'
, transcriptionJobSummary_failureReason
- If the TranscriptionJobStatus
field is FAILED
, a description of the
error.
$sel:contentRedaction:TranscriptionJobSummary'
, transcriptionJobSummary_contentRedaction
- The content redaction settings of the transcription job.
$sel:identifiedLanguageScore:TranscriptionJobSummary'
, transcriptionJobSummary_identifiedLanguageScore
- A value between zero and one that Amazon Transcribe assigned to the
language it identified in the source audio. A higher score indicates
that Amazon Transcribe is more confident in the language it identified.
$sel:languageCode:TranscriptionJobSummary'
, transcriptionJobSummary_languageCode
- The language code for the input speech.
$sel:outputLocationType:TranscriptionJobSummary'
, transcriptionJobSummary_outputLocationType
- Indicates the location of the output of the transcription job.
If the value is CUSTOMER_BUCKET
then the location is the S3 bucket
specified in the outputBucketName
field when the transcription job was
started with the StartTranscriptionJob
operation.
If the value is SERVICE_BUCKET
then the output is stored by Amazon
Transcribe and can be retrieved using the URI in the
GetTranscriptionJob
response's TranscriptFileUri
field.
$sel:startTime:TranscriptionJobSummary'
, transcriptionJobSummary_startTime
- A timestamp that shows when the job started processing.
$sel:completionTime:TranscriptionJobSummary'
, transcriptionJobSummary_completionTime
- A timestamp that shows when the job was completed.
$sel:modelSettings:TranscriptionJobSummary'
, transcriptionJobSummary_modelSettings
- Undocumented member.
$sel:transcriptionJobStatus:TranscriptionJobSummary'
, transcriptionJobSummary_transcriptionJobStatus
- The status of the transcription job. When the status is COMPLETED
, use
the GetTranscriptionJob
operation to get the results of the
transcription.
$sel:transcriptionJobName:TranscriptionJobSummary'
, transcriptionJobSummary_transcriptionJobName
- The name of the transcription job.
$sel:identifyLanguage:TranscriptionJobSummary'
, transcriptionJobSummary_identifyLanguage
- Whether automatic language identification was enabled for a
transcription job.
VocabularyFilterInfo
data VocabularyFilterInfo Source #
Provides information about a vocabulary filter.
See: newVocabularyFilterInfo
smart constructor.
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 of the words in the vocabulary filter.
$sel:lastModifiedTime:VocabularyFilterInfo'
, vocabularyFilterInfo_lastModifiedTime
- The date and time that the vocabulary was last updated.
$sel:vocabularyFilterName:VocabularyFilterInfo'
, vocabularyFilterInfo_vocabularyFilterName
- The name of the vocabulary filter. The name must be unique in the
account that holds the filter.
VocabularyInfo
data VocabularyInfo Source #
Provides information about a custom vocabulary.
See: newVocabularyInfo
smart constructor.
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 of the vocabulary entries.
$sel:vocabularyName:VocabularyInfo'
, vocabularyInfo_vocabularyName
- The name of the vocabulary.
$sel:lastModifiedTime:VocabularyInfo'
, vocabularyInfo_lastModifiedTime
- The date and time that the vocabulary was last modified.
$sel:vocabularyState:VocabularyInfo'
, vocabularyInfo_vocabularyState
- The processing state of the vocabulary. If the state is READY
you can
use the vocabulary in a StartTranscriptionJob
request.