Amazonka.Transcribe.Types.VocabularyInfo

Documentation

data VocabularyInfo

Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

See: newVocabularyInfo smart constructor.

Constructors

VocabularyInfo'

Fields

• languageCode :: Maybe LanguageCode

  The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

  A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

• lastModifiedTime :: Maybe POSIX

  The date and time the specified custom vocabulary was last modified.

  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.

• vocabularyName :: Maybe Text

  A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

• vocabularyState :: Maybe VocabularyState

  The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

Instances

FromJSON VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Methods

parseJSON :: Value -> Parser VocabularyInfo

parseJSONList :: Value -> Parser [VocabularyInfo]

Generic VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Associated Types

type Rep VocabularyInfo :: Type -> Type

Methods

from :: VocabularyInfo -> Rep VocabularyInfo x

to :: Rep VocabularyInfo x -> VocabularyInfo

Read VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Methods

readsPrec :: Int -> ReadS VocabularyInfo

readList :: ReadS [VocabularyInfo]

readPrec :: ReadPrec VocabularyInfo

readListPrec :: ReadPrec [VocabularyInfo]

Show VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Methods

showsPrec :: Int -> VocabularyInfo -> ShowS

show :: VocabularyInfo -> String

showList :: [VocabularyInfo] -> ShowS

NFData VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Methods

rnf :: VocabularyInfo -> ()

Eq VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Methods

(==) :: VocabularyInfo -> VocabularyInfo -> Bool

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

Hashable VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

Methods

hashWithSalt :: Int -> VocabularyInfo -> Int

hash :: VocabularyInfo -> Int

type Rep VocabularyInfo

Defined in Amazonka.Transcribe.Types.VocabularyInfo

type Rep VocabularyInfo = D1 ('MetaData "VocabularyInfo" "Amazonka.Transcribe.Types.VocabularyInfo" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "VocabularyInfo'" '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 "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vocabularyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyState)))))

newVocabularyInfo :: VocabularyInfo

Create a value of VocabularyInfo 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:VocabularyInfo', vocabularyInfo_languageCode - The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

$sel:lastModifiedTime:VocabularyInfo', vocabularyInfo_lastModifiedTime - The date and time the specified custom vocabulary was last modified.

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.

$sel:vocabularyName:VocabularyInfo', vocabularyInfo_vocabularyName - A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

$sel:vocabularyState:VocabularyInfo', vocabularyInfo_vocabularyState - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

vocabularyInfo_languageCode :: Lens' VocabularyInfo (Maybe LanguageCode)

The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

vocabularyInfo_lastModifiedTime :: Lens' VocabularyInfo (Maybe UTCTime)

The date and time the specified custom vocabulary was last modified.

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.

vocabularyInfo_vocabularyName :: Lens' VocabularyInfo (Maybe Text)

A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

vocabularyInfo_vocabularyState :: Lens' VocabularyInfo (Maybe VocabularyState)

The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.