| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.Transcribe.Types
Contents
Description
Synopsis
- transcribe :: 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 LanguageCode
- data MediaFormat
- data TranscriptionJobStatus
- data VocabularyState
- data Media
- media :: Media
- mMediaFileURI :: Lens' Media (Maybe Text)
- data Settings
- settings :: Settings
- sVocabularyName :: Lens' Settings (Maybe Text)
- sMaxSpeakerLabels :: Lens' Settings (Maybe Natural)
- sShowSpeakerLabels :: Lens' Settings (Maybe Bool)
- data Transcript
- transcript :: Transcript
- tTranscriptFileURI :: Lens' Transcript (Maybe Text)
- data TranscriptionJob
- transcriptionJob :: TranscriptionJob
- tjCreationTime :: Lens' TranscriptionJob (Maybe UTCTime)
- tjFailureReason :: Lens' TranscriptionJob (Maybe Text)
- tjLanguageCode :: Lens' TranscriptionJob (Maybe LanguageCode)
- tjSettings :: Lens' TranscriptionJob (Maybe Settings)
- tjCompletionTime :: Lens' TranscriptionJob (Maybe UTCTime)
- tjMedia :: Lens' TranscriptionJob (Maybe Media)
- tjMediaFormat :: Lens' TranscriptionJob (Maybe MediaFormat)
- tjTranscriptionJobStatus :: Lens' TranscriptionJob (Maybe TranscriptionJobStatus)
- tjTranscriptionJobName :: Lens' TranscriptionJob (Maybe Text)
- tjTranscript :: Lens' TranscriptionJob (Maybe Transcript)
- tjMediaSampleRateHertz :: Lens' TranscriptionJob (Maybe Natural)
- data TranscriptionJobSummary
- transcriptionJobSummary :: TranscriptionJobSummary
- tjsCreationTime :: Lens' TranscriptionJobSummary (Maybe UTCTime)
- tjsFailureReason :: Lens' TranscriptionJobSummary (Maybe Text)
- tjsLanguageCode :: Lens' TranscriptionJobSummary (Maybe LanguageCode)
- tjsCompletionTime :: Lens' TranscriptionJobSummary (Maybe UTCTime)
- tjsTranscriptionJobStatus :: Lens' TranscriptionJobSummary (Maybe TranscriptionJobStatus)
- tjsTranscriptionJobName :: Lens' TranscriptionJobSummary (Maybe Text)
- data VocabularyInfo
- vocabularyInfo :: VocabularyInfo
- viLanguageCode :: Lens' VocabularyInfo (Maybe LanguageCode)
- viVocabularyName :: Lens' VocabularyInfo (Maybe Text)
- viLastModifiedTime :: Lens' VocabularyInfo (Maybe UTCTime)
- viVocabularyState :: Lens' VocabularyInfo (Maybe VocabularyState)
Service Configuration
transcribe :: Service Source #
API version 2017-10-26 of the Amazon Transcribe Service SDK configuration.
Errors
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The JobName field is a duplicate of a previously entered job name. Resend your request with a different name.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find the requested transcription job or custom vocabulary. Check the name and try your request again.
_InternalFailureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was an internal error. Check the error message and try your request again.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your request didn't pass one or more validation tests. For example, a name already exists when createing a resource or a name may not exist when getting a transcription job or custom vocabulary. See the exception Message field for more information.
_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.
LanguageCode
data LanguageCode Source #
Instances
MediaFormat
data MediaFormat Source #
Instances
TranscriptionJobStatus
data TranscriptionJobStatus Source #
Constructors
| TJSCompleted | |
| TJSFailed | |
| TJSInProgress |
Instances
VocabularyState
data VocabularyState Source #
Instances
Media
Describes the input media file in a transcription request.
See: media smart constructor.
Instances
| Eq Media Source # | |
| Data Media Source # | |
Defined in Network.AWS.Transcribe.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Media -> c Media # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Media # dataTypeOf :: Media -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Media) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Media) # gmapT :: (forall b. Data b => b -> b) -> Media -> Media # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Media -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Media -> r # gmapQ :: (forall d. Data d => d -> u) -> Media -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Media -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Media -> m Media # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Media -> m Media # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Media -> m Media # | |
| Read Media Source # | |
| Show Media Source # | |
| Generic Media Source # | |
| Hashable Media Source # | |
Defined in Network.AWS.Transcribe.Types.Product | |
| ToJSON Media Source # | |
Defined in Network.AWS.Transcribe.Types.Product | |
| FromJSON Media Source # | |
| NFData Media Source # | |
Defined in Network.AWS.Transcribe.Types.Product | |
| type Rep Media Source # | |
Defined in Network.AWS.Transcribe.Types.Product | |
Creates a value of Media with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMediaFileURI- The S3 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:https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>For example:https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
mMediaFileURI :: Lens' Media (Maybe Text) Source #
The S3 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: https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> For example: https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4 https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4 For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide .
Settings
Provides optional settings for the StartTranscriptionJob operation.
See: settings smart constructor.
Instances
Creates a value of Settings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sVocabularyName- The name of a vocabulary to use when processing the transcription job.sMaxSpeakerLabels- The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify theMaxSpeakerLabelsfield, you must set theShowSpeakerLabelsfield to true.sShowSpeakerLabels- Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set theShowSpeakerLabelsfield to true, you must also set the maximum number of speaker labelsMaxSpeakerLabelsfield.
sVocabularyName :: Lens' Settings (Maybe Text) Source #
The name of a vocabulary to use when processing the transcription job.
sMaxSpeakerLabels :: Lens' Settings (Maybe Natural) Source #
The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
sShowSpeakerLabels :: Lens' Settings (Maybe Bool) Source #
Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.
Transcript
data Transcript Source #
Describes the output of a transcription job.
See: transcript smart constructor.
Instances
transcript :: Transcript Source #
Creates a value of Transcript with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tTranscriptFileURI- The S3 location where the transcription result is stored. Use this URI to access the results of the transcription job.
tTranscriptFileURI :: Lens' Transcript (Maybe Text) Source #
The S3 location where the transcription result is stored. Use this URI to access the results of the transcription job.
TranscriptionJob
data TranscriptionJob Source #
Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.
See: transcriptionJob smart constructor.
Instances
transcriptionJob :: TranscriptionJob Source #
Creates a value of TranscriptionJob with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tjCreationTime- Timestamp of the date and time that the job was created.tjFailureReason- If theTranscriptionJobStatusfield isFAILED, this field contains information about why the job failed.tjLanguageCode- The language code for the input speech.tjSettings- Optional settings for the transcription job.tjCompletionTime- Timestamp of the date and time that the job completed.tjMedia- An object that describes the input media for a transcription job.tjMediaFormat- The format of the input media file.tjTranscriptionJobStatus- The status of the transcription job.tjTranscriptionJobName- A name to identify the transcription job.tjTranscript- An object that describes the output of the transcription job.tjMediaSampleRateHertz- The sample rate, in Hertz, of the audio track in the input media file.
tjCreationTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #
Timestamp of the date and time that the job was created.
tjFailureReason :: Lens' TranscriptionJob (Maybe Text) Source #
If the TranscriptionJobStatus field is FAILED , this field contains information about why the job failed.
tjLanguageCode :: Lens' TranscriptionJob (Maybe LanguageCode) Source #
The language code for the input speech.
tjSettings :: Lens' TranscriptionJob (Maybe Settings) Source #
Optional settings for the transcription job.
tjCompletionTime :: Lens' TranscriptionJob (Maybe UTCTime) Source #
Timestamp of the date and time that the job completed.
tjMedia :: Lens' TranscriptionJob (Maybe Media) Source #
An object that describes the input media for a transcription job.
tjMediaFormat :: Lens' TranscriptionJob (Maybe MediaFormat) Source #
The format of the input media file.
tjTranscriptionJobStatus :: Lens' TranscriptionJob (Maybe TranscriptionJobStatus) Source #
The status of the transcription job.
tjTranscriptionJobName :: Lens' TranscriptionJob (Maybe Text) Source #
A name to identify the transcription job.
tjTranscript :: Lens' TranscriptionJob (Maybe Transcript) Source #
An object that describes the output of the transcription job.
tjMediaSampleRateHertz :: Lens' TranscriptionJob (Maybe Natural) Source #
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: transcriptionJobSummary smart constructor.
Instances
transcriptionJobSummary :: TranscriptionJobSummary Source #
Creates a value of TranscriptionJobSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tjsCreationTime- Timestamp of the date and time that the job was created.tjsFailureReason- If theTranscriptionJobStatusfield isFAILED, this field contains a description of the error.tjsLanguageCode- The language code for the input speech.tjsCompletionTime- Timestamp of the date and time that the job completed.tjsTranscriptionJobStatus- The status of the transcription job. When the status isCOMPLETED, use theGetTranscriptionJoboperation to get the results of the transcription.tjsTranscriptionJobName- The name assigned to the transcription job when it was created.
tjsCreationTime :: Lens' TranscriptionJobSummary (Maybe UTCTime) Source #
Timestamp of the date and time that the job was created.
tjsFailureReason :: Lens' TranscriptionJobSummary (Maybe Text) Source #
If the TranscriptionJobStatus field is FAILED , this field contains a description of the error.
tjsLanguageCode :: Lens' TranscriptionJobSummary (Maybe LanguageCode) Source #
The language code for the input speech.
tjsCompletionTime :: Lens' TranscriptionJobSummary (Maybe UTCTime) Source #
Timestamp of the date and time that the job completed.
tjsTranscriptionJobStatus :: Lens' TranscriptionJobSummary (Maybe TranscriptionJobStatus) Source #
The status of the transcription job. When the status is COMPLETED , use the GetTranscriptionJob operation to get the results of the transcription.
tjsTranscriptionJobName :: Lens' TranscriptionJobSummary (Maybe Text) Source #
The name assigned to the transcription job when it was created.
VocabularyInfo
data VocabularyInfo Source #
Provides information about a custom vocabulary.
See: vocabularyInfo smart constructor.
Instances
vocabularyInfo :: VocabularyInfo Source #
Creates a value of VocabularyInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
viLanguageCode- The language code of the vocabulary entries.viVocabularyName- The name of the vocabulary.viLastModifiedTime- The date and time that the vocabulary was last modified.viVocabularyState- The processing state of the vocabulary. If the state isREADYyou can use the vocabulary in aStartTranscriptionJobrequest.
viLanguageCode :: Lens' VocabularyInfo (Maybe LanguageCode) Source #
The language code of the vocabulary entries.
viVocabularyName :: Lens' VocabularyInfo (Maybe Text) Source #
The name of the vocabulary.
viLastModifiedTime :: Lens' VocabularyInfo (Maybe UTCTime) Source #
The date and time that the vocabulary was last modified.
viVocabularyState :: Lens' VocabularyInfo (Maybe VocabularyState) Source #
The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.