Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transcribe.UpdateVocabularyFilter

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing custom vocabulary filter with a new list of words. The new list you provide overwrites all previous entries; you cannot append new terms onto an existing custom vocabulary filter.

Synopsis

Creating a Request

data UpdateVocabularyFilter Source #

See: newUpdateVocabularyFilter smart constructor.

Constructors

UpdateVocabularyFilter'

Fields

vocabularyFilterFileUri :: Maybe Text
The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt
Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.
words :: Maybe (NonEmpty Text)
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.
Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.
Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.
vocabularyFilterName :: Text
The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

Instances

Instances details

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

newUpdateVocabularyFilter Source #

Arguments

:: Text	`UpdateVocabularyFilter`
-> UpdateVocabularyFilter

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 the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

$sel:words:UpdateVocabularyFilter', updateVocabularyFilter_words - Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

UpdateVocabularyFilter, updateVocabularyFilter_vocabularyFilterName - The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

Request Lenses

updateVocabularyFilter_vocabularyFilterFileUri :: Lens' UpdateVocabularyFilter (Maybe Text) Source #

The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; you must choose one or the other.

updateVocabularyFilter_words :: Lens' UpdateVocabularyFilter (Maybe (NonEmpty Text)) Source #

Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; you must choose one or the other.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

updateVocabularyFilter_vocabularyFilterName :: Lens' UpdateVocabularyFilter Text Source #

The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.

Destructuring the Response

data UpdateVocabularyFilterResponse Source #

See: newUpdateVocabularyFilterResponse smart constructor.

Constructors

UpdateVocabularyFilterResponse'

Fields

languageCode :: Maybe LanguageCode
The language code you selected for your custom vocabulary filter.
lastModifiedTime :: Maybe POSIX
The date and time the specified custom vocabulary filter was last updated.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
vocabularyFilterName :: Maybe Text
The name of the updated custom vocabulary filter.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateVocabularyFilterResponse Source #

Arguments

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

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:

UpdateVocabularyFilterResponse, updateVocabularyFilterResponse_languageCode - The language code you selected for your custom vocabulary filter.

UpdateVocabularyFilterResponse, updateVocabularyFilterResponse_lastModifiedTime - The date and time the specified custom vocabulary filter was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

UpdateVocabularyFilter, updateVocabularyFilterResponse_vocabularyFilterName - The name of the updated custom vocabulary filter.

$sel:httpStatus:UpdateVocabularyFilterResponse', updateVocabularyFilterResponse_httpStatus - The response's http status code.

Response Lenses

updateVocabularyFilterResponse_languageCode :: Lens' UpdateVocabularyFilterResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary filter.

updateVocabularyFilterResponse_lastModifiedTime :: Lens' UpdateVocabularyFilterResponse (Maybe UTCTime) Source #

The date and time the specified custom vocabulary filter was last updated.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

updateVocabularyFilterResponse_vocabularyFilterName :: Lens' UpdateVocabularyFilterResponse (Maybe Text) Source #

The name of the updated custom vocabulary filter.

updateVocabularyFilterResponse_httpStatus :: Lens' UpdateVocabularyFilterResponse Int Source #

The response's http status code.