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

Amazonka.Transcribe.CreateVocabulary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

Synopsis

data CreateVocabulary = CreateVocabulary' {
- vocabularyFileUri :: Maybe Text
- phrases :: Maybe [Text]
- tags :: Maybe (NonEmpty Tag)
- vocabularyName :: Text
- languageCode :: LanguageCode
}
newCreateVocabulary :: Text -> LanguageCode -> CreateVocabulary
createVocabulary_vocabularyFileUri :: Lens' CreateVocabulary (Maybe Text)
createVocabulary_phrases :: Lens' CreateVocabulary (Maybe [Text])
createVocabulary_tags :: Lens' CreateVocabulary (Maybe (NonEmpty Tag))
createVocabulary_vocabularyName :: Lens' CreateVocabulary Text
createVocabulary_languageCode :: Lens' CreateVocabulary LanguageCode
data CreateVocabularyResponse = CreateVocabularyResponse' {
- failureReason :: Maybe Text
- languageCode :: Maybe LanguageCode
- vocabularyName :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- vocabularyState :: Maybe VocabularyState
- httpStatus :: Int
}
newCreateVocabularyResponse :: Int -> CreateVocabularyResponse
createVocabularyResponse_failureReason :: Lens' CreateVocabularyResponse (Maybe Text)
createVocabularyResponse_languageCode :: Lens' CreateVocabularyResponse (Maybe LanguageCode)
createVocabularyResponse_vocabularyName :: Lens' CreateVocabularyResponse (Maybe Text)
createVocabularyResponse_lastModifiedTime :: Lens' CreateVocabularyResponse (Maybe UTCTime)
createVocabularyResponse_vocabularyState :: Lens' CreateVocabularyResponse (Maybe VocabularyState)
createVocabularyResponse_httpStatus :: Lens' CreateVocabularyResponse Int

Creating a Request

data CreateVocabulary Source #

See: newCreateVocabulary smart constructor.

Constructors

CreateVocabulary'

Fields

vocabularyFileUri :: Maybe Text
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.
phrases :: Maybe [Text]
An array of strings that contains the vocabulary entries.
tags :: Maybe (NonEmpty Tag)
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.
vocabularyName :: Text
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.
languageCode :: LanguageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.

Instances

Instances details

Eq CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods (==) :: CreateVocabulary -> CreateVocabulary -> Bool # (/=) :: CreateVocabulary -> CreateVocabulary -> Bool #
Read CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods readsPrec :: Int -> ReadS CreateVocabulary # readList :: ReadS [CreateVocabulary] # readPrec :: ReadPrec CreateVocabulary # readListPrec :: ReadPrec [CreateVocabulary] #
Show CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods showsPrec :: Int -> CreateVocabulary -> ShowS # show :: CreateVocabulary -> String # showList :: [CreateVocabulary] -> ShowS #
Generic CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Associated Types type Rep CreateVocabulary :: Type -> Type # Methods from :: CreateVocabulary -> Rep CreateVocabulary x # to :: Rep CreateVocabulary x -> CreateVocabulary #
NFData CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods rnf :: CreateVocabulary -> () #
Hashable CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods hashWithSalt :: Int -> CreateVocabulary -> Int # hash :: CreateVocabulary -> Int #
ToJSON CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods toJSON :: CreateVocabulary -> Value # toEncoding :: CreateVocabulary -> Encoding # toJSONList :: [CreateVocabulary] -> Value # toEncodingList :: [CreateVocabulary] -> Encoding #
AWSRequest CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Associated Types type AWSResponse CreateVocabulary # Methods request :: CreateVocabulary -> Request CreateVocabulary # response :: MonadResource m => Logger -> Service -> Proxy CreateVocabulary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateVocabulary))) #
ToHeaders CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods toHeaders :: CreateVocabulary -> [Header] #
ToPath CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods toPath :: CreateVocabulary -> ByteString #
ToQuery CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods toQuery :: CreateVocabulary -> QueryString #
type Rep CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary type Rep CreateVocabulary = D1 ('MetaData "CreateVocabulary" "Amazonka.Transcribe.CreateVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "CreateVocabulary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vocabularyFileUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "phrases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: (S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode)))))
type AWSResponse CreateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary type AWSResponse CreateVocabulary = CreateVocabularyResponse

newCreateVocabulary Source #

Arguments

:: Text	`$sel:vocabularyName:CreateVocabulary'`
-> LanguageCode	`$sel:languageCode:CreateVocabulary'`
-> 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.

Request Lenses

createVocabulary_vocabularyFileUri :: Lens' CreateVocabulary (Maybe Text) Source #

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.

createVocabulary_phrases :: Lens' CreateVocabulary (Maybe [Text]) Source #

An array of strings that contains the vocabulary entries.

createVocabulary_tags :: Lens' CreateVocabulary (Maybe (NonEmpty Tag)) Source #

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.

createVocabulary_vocabularyName :: Lens' CreateVocabulary Text Source #

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.

createVocabulary_languageCode :: Lens' CreateVocabulary LanguageCode Source #

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.

Destructuring the Response

data CreateVocabularyResponse Source #

See: newCreateVocabularyResponse smart constructor.

Constructors

CreateVocabularyResponse'

Fields

failureReason :: Maybe Text
If the VocabularyState field is FAILED, this field contains information about why the job failed.
languageCode :: Maybe LanguageCode
The language code of the vocabulary entries.
vocabularyName :: Maybe Text
The name of the vocabulary.
lastModifiedTime :: Maybe POSIX
The date and time that the vocabulary was created.
vocabularyState :: Maybe VocabularyState
The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods (==) :: CreateVocabularyResponse -> CreateVocabularyResponse -> Bool # (/=) :: CreateVocabularyResponse -> CreateVocabularyResponse -> Bool #
Read CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods readsPrec :: Int -> ReadS CreateVocabularyResponse # readList :: ReadS [CreateVocabularyResponse] # readPrec :: ReadPrec CreateVocabularyResponse # readListPrec :: ReadPrec [CreateVocabularyResponse] #
Show CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods showsPrec :: Int -> CreateVocabularyResponse -> ShowS # show :: CreateVocabularyResponse -> String # showList :: [CreateVocabularyResponse] -> ShowS #
Generic CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Associated Types type Rep CreateVocabularyResponse :: Type -> Type # Methods from :: CreateVocabularyResponse -> Rep CreateVocabularyResponse x # to :: Rep CreateVocabularyResponse x -> CreateVocabularyResponse #
NFData CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary Methods rnf :: CreateVocabularyResponse -> () #
type Rep CreateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateVocabulary type Rep CreateVocabularyResponse = D1 ('MetaData "CreateVocabularyResponse" "Amazonka.Transcribe.CreateVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "CreateVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "vocabularyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateVocabularyResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateVocabularyResponse'`
-> CreateVocabularyResponse

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.

Response Lenses

createVocabularyResponse_failureReason :: Lens' CreateVocabularyResponse (Maybe Text) Source #

If the VocabularyState field is FAILED, this field contains information about why the job failed.

createVocabularyResponse_languageCode :: Lens' CreateVocabularyResponse (Maybe LanguageCode) Source #

The language code of the vocabulary entries.

createVocabularyResponse_vocabularyName :: Lens' CreateVocabularyResponse (Maybe Text) Source #

The name of the vocabulary.

createVocabularyResponse_lastModifiedTime :: Lens' CreateVocabularyResponse (Maybe UTCTime) Source #

The date and time that the vocabulary was created.

createVocabularyResponse_vocabularyState :: Lens' CreateVocabularyResponse (Maybe VocabularyState) Source #

The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

createVocabularyResponse_httpStatus :: Lens' CreateVocabularyResponse Int Source #

The response's http status code.