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.UpdateVocabulary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Synopsis

data UpdateVocabulary = UpdateVocabulary' {
- vocabularyFileUri :: Maybe Text
- phrases :: Maybe [Text]
- vocabularyName :: Text
- languageCode :: LanguageCode
}
newUpdateVocabulary :: Text -> LanguageCode -> UpdateVocabulary
updateVocabulary_vocabularyFileUri :: Lens' UpdateVocabulary (Maybe Text)
updateVocabulary_phrases :: Lens' UpdateVocabulary (Maybe [Text])
updateVocabulary_vocabularyName :: Lens' UpdateVocabulary Text
updateVocabulary_languageCode :: Lens' UpdateVocabulary LanguageCode
data UpdateVocabularyResponse = UpdateVocabularyResponse' {
- languageCode :: Maybe LanguageCode
- vocabularyName :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- vocabularyState :: Maybe VocabularyState
- httpStatus :: Int
}
newUpdateVocabularyResponse :: Int -> UpdateVocabularyResponse
updateVocabularyResponse_languageCode :: Lens' UpdateVocabularyResponse (Maybe LanguageCode)
updateVocabularyResponse_vocabularyName :: Lens' UpdateVocabularyResponse (Maybe Text)
updateVocabularyResponse_lastModifiedTime :: Lens' UpdateVocabularyResponse (Maybe UTCTime)
updateVocabularyResponse_vocabularyState :: Lens' UpdateVocabularyResponse (Maybe VocabularyState)
updateVocabularyResponse_httpStatus :: Lens' UpdateVocabularyResponse Int

Creating a Request

data UpdateVocabulary Source #

See: newUpdateVocabulary smart constructor.

Constructors

UpdateVocabulary'

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 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.
phrases :: Maybe [Text]
An array of strings containing the vocabulary entries.
vocabularyName :: Text
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.
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 UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods (==) :: UpdateVocabulary -> UpdateVocabulary -> Bool # (/=) :: UpdateVocabulary -> UpdateVocabulary -> Bool #
Read UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods readsPrec :: Int -> ReadS UpdateVocabulary # readList :: ReadS [UpdateVocabulary] # readPrec :: ReadPrec UpdateVocabulary # readListPrec :: ReadPrec [UpdateVocabulary] #
Show UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods showsPrec :: Int -> UpdateVocabulary -> ShowS # show :: UpdateVocabulary -> String # showList :: [UpdateVocabulary] -> ShowS #
Generic UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Associated Types type Rep UpdateVocabulary :: Type -> Type # Methods from :: UpdateVocabulary -> Rep UpdateVocabulary x # to :: Rep UpdateVocabulary x -> UpdateVocabulary #
NFData UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods rnf :: UpdateVocabulary -> () #
Hashable UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods hashWithSalt :: Int -> UpdateVocabulary -> Int # hash :: UpdateVocabulary -> Int #
ToJSON UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods toJSON :: UpdateVocabulary -> Value # toEncoding :: UpdateVocabulary -> Encoding # toJSONList :: [UpdateVocabulary] -> Value # toEncodingList :: [UpdateVocabulary] -> Encoding #
AWSRequest UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Associated Types type AWSResponse UpdateVocabulary # Methods request :: UpdateVocabulary -> Request UpdateVocabulary # response :: MonadResource m => Logger -> Service -> Proxy UpdateVocabulary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateVocabulary))) #
ToHeaders UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods toHeaders :: UpdateVocabulary -> [Header] #
ToPath UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods toPath :: UpdateVocabulary -> ByteString #
ToQuery UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods toQuery :: UpdateVocabulary -> QueryString #
type Rep UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary type Rep UpdateVocabulary = D1 ('MetaData "UpdateVocabulary" "Amazonka.Transcribe.UpdateVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "UpdateVocabulary'" '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 "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LanguageCode))))
type AWSResponse UpdateVocabulary Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary type AWSResponse UpdateVocabulary = UpdateVocabularyResponse

newUpdateVocabulary Source #

Arguments

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

Request Lenses

updateVocabulary_vocabularyFileUri :: Lens' UpdateVocabulary (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 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.

updateVocabulary_phrases :: Lens' UpdateVocabulary (Maybe [Text]) Source #

An array of strings containing the vocabulary entries.

updateVocabulary_vocabularyName :: Lens' UpdateVocabulary Text Source #

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.

updateVocabulary_languageCode :: Lens' UpdateVocabulary 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 UpdateVocabularyResponse Source #

See: newUpdateVocabularyResponse smart constructor.

Constructors

UpdateVocabularyResponse'

Fields

languageCode :: Maybe LanguageCode
The language code of the vocabulary entries.
vocabularyName :: Maybe Text
The name of the vocabulary that was updated.
lastModifiedTime :: Maybe POSIX
The date and time that the vocabulary was updated.
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 UpdateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods (==) :: UpdateVocabularyResponse -> UpdateVocabularyResponse -> Bool # (/=) :: UpdateVocabularyResponse -> UpdateVocabularyResponse -> Bool #
Read UpdateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods readsPrec :: Int -> ReadS UpdateVocabularyResponse # readList :: ReadS [UpdateVocabularyResponse] # readPrec :: ReadPrec UpdateVocabularyResponse # readListPrec :: ReadPrec [UpdateVocabularyResponse] #
Show UpdateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods showsPrec :: Int -> UpdateVocabularyResponse -> ShowS # show :: UpdateVocabularyResponse -> String # showList :: [UpdateVocabularyResponse] -> ShowS #
Generic UpdateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Associated Types type Rep UpdateVocabularyResponse :: Type -> Type # Methods from :: UpdateVocabularyResponse -> Rep UpdateVocabularyResponse x # to :: Rep UpdateVocabularyResponse x -> UpdateVocabularyResponse #
NFData UpdateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary Methods rnf :: UpdateVocabularyResponse -> () #
type Rep UpdateVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateVocabulary type Rep UpdateVocabularyResponse = D1 ('MetaData "UpdateVocabularyResponse" "Amazonka.Transcribe.UpdateVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "UpdateVocabularyResponse'" 'PrefixI 'True) ((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)))))

newUpdateVocabularyResponse Source #

Arguments

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

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.

Response Lenses

updateVocabularyResponse_languageCode :: Lens' UpdateVocabularyResponse (Maybe LanguageCode) Source #

The language code of the vocabulary entries.

updateVocabularyResponse_vocabularyName :: Lens' UpdateVocabularyResponse (Maybe Text) Source #

The name of the vocabulary that was updated.

updateVocabularyResponse_lastModifiedTime :: Lens' UpdateVocabularyResponse (Maybe UTCTime) Source #

The date and time that the vocabulary was updated.

updateVocabularyResponse_vocabularyState :: Lens' UpdateVocabularyResponse (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.

updateVocabularyResponse_httpStatus :: Lens' UpdateVocabularyResponse Int Source #

The response's http status code.