Network.AWS.Transcribe.StartTranscriptionJob

Starts an asynchronous job to transcribe speech to text.

Creating a Request

startTranscriptionJob

Arguments

:: Text

stjTranscriptionJobName

-> LanguageCode

stjLanguageCode

-> MediaFormat

stjMediaFormat

-> Media

stjMedia

-> StartTranscriptionJob

Creates a value of StartTranscriptionJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stjSettings - A Settings object that provides optional settings for a transcription job.
• stjMediaSampleRateHertz - The sample rate, in Hertz, of the audio track in the input media file.
• stjTranscriptionJobName - The name of the job. The name must be unique within an AWS account.
• stjLanguageCode - The language code for the language used in the input media file.
• stjMediaFormat - The format of the input media file.
• stjMedia - An object that describes the input media for a transcription job.

data StartTranscriptionJob

See: startTranscriptionJob smart constructor.

Instances

Eq StartTranscriptionJob

Methods

(==) :: StartTranscriptionJob -> StartTranscriptionJob -> Bool

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

Data StartTranscriptionJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartTranscriptionJob -> c StartTranscriptionJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartTranscriptionJob

toConstr :: StartTranscriptionJob -> Constr

dataTypeOf :: StartTranscriptionJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartTranscriptionJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartTranscriptionJob)

gmapT :: (forall b. Data b => b -> b) -> StartTranscriptionJob -> StartTranscriptionJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartTranscriptionJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartTranscriptionJob -> r

gmapQ :: (forall d. Data d => d -> u) -> StartTranscriptionJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartTranscriptionJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartTranscriptionJob -> m StartTranscriptionJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTranscriptionJob -> m StartTranscriptionJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTranscriptionJob -> m StartTranscriptionJob

Read StartTranscriptionJob

Methods

readsPrec :: Int -> ReadS StartTranscriptionJob

readList :: ReadS [StartTranscriptionJob]

readPrec :: ReadPrec StartTranscriptionJob

readListPrec :: ReadPrec [StartTranscriptionJob]

Show StartTranscriptionJob

Methods

showsPrec :: Int -> StartTranscriptionJob -> ShowS

show :: StartTranscriptionJob -> String

showList :: [StartTranscriptionJob] -> ShowS

Generic StartTranscriptionJob

Associated Types

type Rep StartTranscriptionJob :: * -> *

Methods

from :: StartTranscriptionJob -> Rep StartTranscriptionJob x

to :: Rep StartTranscriptionJob x -> StartTranscriptionJob

Hashable StartTranscriptionJob

Methods

hashWithSalt :: Int -> StartTranscriptionJob -> Int

hash :: StartTranscriptionJob -> Int

ToJSON StartTranscriptionJob

Methods

toJSON :: StartTranscriptionJob -> Value

toEncoding :: StartTranscriptionJob -> Encoding

toJSONList :: [StartTranscriptionJob] -> Value

toEncodingList :: [StartTranscriptionJob] -> Encoding

NFData StartTranscriptionJob

Methods

rnf :: StartTranscriptionJob -> ()

AWSRequest StartTranscriptionJob

Associated Types

type Rs StartTranscriptionJob :: *

Methods

request :: StartTranscriptionJob -> Request StartTranscriptionJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StartTranscriptionJob -> ClientResponse -> m (Response StartTranscriptionJob)

ToHeaders StartTranscriptionJob

Methods

toHeaders :: StartTranscriptionJob -> [Header]

ToPath StartTranscriptionJob

Methods

toPath :: StartTranscriptionJob -> ByteString

ToQuery StartTranscriptionJob

Methods

toQuery :: StartTranscriptionJob -> QueryString

type Rep StartTranscriptionJob

type Rep StartTranscriptionJob = D1 * (MetaData "StartTranscriptionJob" "Network.AWS.Transcribe.StartTranscriptionJob" "amazonka-transcribe-1.6.0-EAJHmFqYXYhFnJ8LH2D7KC" False) (C1 * (MetaCons "StartTranscriptionJob'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_stjSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Settings))) ((:*:) * (S1 * (MetaSel (Just Symbol "_stjMediaSampleRateHertz") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_stjTranscriptionJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_stjLanguageCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * LanguageCode)) ((:*:) * (S1 * (MetaSel (Just Symbol "_stjMediaFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MediaFormat)) (S1 * (MetaSel (Just Symbol "_stjMedia") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Media))))))

type Rs StartTranscriptionJob

type Rs StartTranscriptionJob = StartTranscriptionJobResponse

Request Lenses

stjSettings :: Lens' StartTranscriptionJob (Maybe Settings)

A Settings object that provides optional settings for a transcription job.

stjMediaSampleRateHertz :: Lens' StartTranscriptionJob (Maybe Natural)

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

stjTranscriptionJobName :: Lens' StartTranscriptionJob Text

The name of the job. The name must be unique within an AWS account.

stjLanguageCode :: Lens' StartTranscriptionJob LanguageCode

The language code for the language used in the input media file.

stjMediaFormat :: Lens' StartTranscriptionJob MediaFormat

The format of the input media file.

stjMedia :: Lens' StartTranscriptionJob Media

An object that describes the input media for a transcription job.

Destructuring the Response

startTranscriptionJobResponse

Arguments

:: Int

stjrsResponseStatus

-> StartTranscriptionJobResponse

Creates a value of StartTranscriptionJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• stjrsTranscriptionJob - An object containing details of the asynchronous transcription job.
• stjrsResponseStatus - -- | The response status code.

data StartTranscriptionJobResponse

See: startTranscriptionJobResponse smart constructor.

Instances

Eq StartTranscriptionJobResponse

Methods

(==) :: StartTranscriptionJobResponse -> StartTranscriptionJobResponse -> Bool

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

Data StartTranscriptionJobResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartTranscriptionJobResponse -> c StartTranscriptionJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartTranscriptionJobResponse

toConstr :: StartTranscriptionJobResponse -> Constr

dataTypeOf :: StartTranscriptionJobResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartTranscriptionJobResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartTranscriptionJobResponse)

gmapT :: (forall b. Data b => b -> b) -> StartTranscriptionJobResponse -> StartTranscriptionJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartTranscriptionJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartTranscriptionJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartTranscriptionJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartTranscriptionJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartTranscriptionJobResponse -> m StartTranscriptionJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTranscriptionJobResponse -> m StartTranscriptionJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartTranscriptionJobResponse -> m StartTranscriptionJobResponse

Read StartTranscriptionJobResponse

Methods

readsPrec :: Int -> ReadS StartTranscriptionJobResponse

readList :: ReadS [StartTranscriptionJobResponse]

readPrec :: ReadPrec StartTranscriptionJobResponse

readListPrec :: ReadPrec [StartTranscriptionJobResponse]

Show StartTranscriptionJobResponse

Methods

showsPrec :: Int -> StartTranscriptionJobResponse -> ShowS

show :: StartTranscriptionJobResponse -> String

showList :: [StartTranscriptionJobResponse] -> ShowS

Generic StartTranscriptionJobResponse

Associated Types

type Rep StartTranscriptionJobResponse :: * -> *

Methods

from :: StartTranscriptionJobResponse -> Rep StartTranscriptionJobResponse x

to :: Rep StartTranscriptionJobResponse x -> StartTranscriptionJobResponse

NFData StartTranscriptionJobResponse

Methods

rnf :: StartTranscriptionJobResponse -> ()

type Rep StartTranscriptionJobResponse

type Rep StartTranscriptionJobResponse = D1 * (MetaData "StartTranscriptionJobResponse" "Network.AWS.Transcribe.StartTranscriptionJob" "amazonka-transcribe-1.6.0-EAJHmFqYXYhFnJ8LH2D7KC" False) (C1 * (MetaCons "StartTranscriptionJobResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_stjrsTranscriptionJob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TranscriptionJob))) (S1 * (MetaSel (Just Symbol "_stjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

stjrsTranscriptionJob :: Lens' StartTranscriptionJobResponse (Maybe TranscriptionJob)

An object containing details of the asynchronous transcription job.

stjrsResponseStatus :: Lens' StartTranscriptionJobResponse Int

• - | The response status code.