| 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.CreateVocabularyFilter
Description
Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
Synopsis
- data CreateVocabularyFilter = CreateVocabularyFilter' {}
- newCreateVocabularyFilter :: Text -> LanguageCode -> CreateVocabularyFilter
- createVocabularyFilter_vocabularyFilterFileUri :: Lens' CreateVocabularyFilter (Maybe Text)
- createVocabularyFilter_words :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Text))
- createVocabularyFilter_tags :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Tag))
- createVocabularyFilter_vocabularyFilterName :: Lens' CreateVocabularyFilter Text
- createVocabularyFilter_languageCode :: Lens' CreateVocabularyFilter LanguageCode
- data CreateVocabularyFilterResponse = CreateVocabularyFilterResponse' {}
- newCreateVocabularyFilterResponse :: Int -> CreateVocabularyFilterResponse
- createVocabularyFilterResponse_languageCode :: Lens' CreateVocabularyFilterResponse (Maybe LanguageCode)
- createVocabularyFilterResponse_lastModifiedTime :: Lens' CreateVocabularyFilterResponse (Maybe UTCTime)
- createVocabularyFilterResponse_vocabularyFilterName :: Lens' CreateVocabularyFilterResponse (Maybe Text)
- createVocabularyFilterResponse_httpStatus :: Lens' CreateVocabularyFilterResponse Int
Creating a Request
data CreateVocabularyFilter Source #
See: newCreateVocabularyFilter smart constructor.
Constructors
| CreateVocabularyFilter' | |
Fields
| |
Instances
newCreateVocabularyFilter Source #
Arguments
| :: Text | |
| -> LanguageCode | |
| -> CreateVocabularyFilter |
Create a value of CreateVocabularyFilter 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:CreateVocabularyFilter', createVocabularyFilter_vocabularyFilterFileUri - The Amazon S3 location of a text file used as input to create the
vocabulary filter. Only use characters from the character set defined
for custom vocabularies. For a list of character sets, see
Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the
VocabularyFilterFileUri parameter, you can't use the Words
parameter.
$sel:words:CreateVocabularyFilter', createVocabularyFilter_words - The words to use in the vocabulary filter. Only use characters from the
character set defined for custom vocabularies. For a list of character
sets, see
Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use
the VocabularyFilterFileUri parameter.
$sel:tags:CreateVocabularyFilter', createVocabularyFilter_tags - Adds one or more tags, each in the form of a key:value pair, to a new
Amazon Transcribe vocabulary filter at the time you create this new
vocabulary filter.
$sel:vocabularyFilterName:CreateVocabularyFilter', createVocabularyFilter_vocabularyFilterName - The vocabulary filter name. The name must be unique within the account
that contains it. If you try to create a vocabulary filter with the same
name as another vocabulary filter, you get a ConflictException error.
$sel:languageCode:CreateVocabularyFilter', createVocabularyFilter_languageCode - The language code of the words in the vocabulary filter. All words in
the filter must be in the same language. The vocabulary filter can only
be used with transcription jobs in the specified language.
Request Lenses
createVocabularyFilter_vocabularyFilterFileUri :: Lens' CreateVocabularyFilter (Maybe Text) Source #
The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
The specified file must be less than 50 KB of UTF-8 characters.
If you provide the location of a list of words in the
VocabularyFilterFileUri parameter, you can't use the Words
parameter.
createVocabularyFilter_words :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Text)) Source #
The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.
If you provide a list of words in the Words parameter, you can't use
the VocabularyFilterFileUri parameter.
createVocabularyFilter_tags :: Lens' CreateVocabularyFilter (Maybe (NonEmpty Tag)) Source #
Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you create this new vocabulary filter.
createVocabularyFilter_vocabularyFilterName :: Lens' CreateVocabularyFilter Text Source #
The vocabulary filter name. The name must be unique within the account
that contains it. If you try to create a vocabulary filter with the same
name as another vocabulary filter, you get a ConflictException error.
createVocabularyFilter_languageCode :: Lens' CreateVocabularyFilter LanguageCode Source #
The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
Destructuring the Response
data CreateVocabularyFilterResponse Source #
See: newCreateVocabularyFilterResponse smart constructor.
Constructors
| CreateVocabularyFilterResponse' | |
Fields
| |
Instances
newCreateVocabularyFilterResponse Source #
Create a value of CreateVocabularyFilterResponse 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:CreateVocabularyFilter', createVocabularyFilterResponse_languageCode - The language code of the words in the collection.
$sel:lastModifiedTime:CreateVocabularyFilterResponse', createVocabularyFilterResponse_lastModifiedTime - The date and time that the vocabulary filter was modified.
$sel:vocabularyFilterName:CreateVocabularyFilter', createVocabularyFilterResponse_vocabularyFilterName - The name of the vocabulary filter.
$sel:httpStatus:CreateVocabularyFilterResponse', createVocabularyFilterResponse_httpStatus - The response's http status code.
Response Lenses
createVocabularyFilterResponse_languageCode :: Lens' CreateVocabularyFilterResponse (Maybe LanguageCode) Source #
The language code of the words in the collection.
createVocabularyFilterResponse_lastModifiedTime :: Lens' CreateVocabularyFilterResponse (Maybe UTCTime) Source #
The date and time that the vocabulary filter was modified.
createVocabularyFilterResponse_vocabularyFilterName :: Lens' CreateVocabularyFilterResponse (Maybe Text) Source #
The name of the vocabulary filter.
createVocabularyFilterResponse_httpStatus :: Lens' CreateVocabularyFilterResponse Int Source #
The response's http status code.