amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.GetVocabulary

Description

Provides information about the specified custom vocabulary.

To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

To get a list of your custom vocabularies, use the operation.

Synopsis

Creating a Request

data GetVocabulary Source #

See: newGetVocabulary smart constructor.

Constructors

GetVocabulary' 

Fields

  • vocabularyName :: Text

    The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

Instances

Instances details
ToJSON GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

toJSON :: GetVocabulary -> Value #

toEncoding :: GetVocabulary -> Encoding #

toJSONList :: [GetVocabulary] -> Value #

toEncodingList :: [GetVocabulary] -> Encoding #

ToHeaders GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

toHeaders :: GetVocabulary -> [Header] #

ToPath GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

toPath :: GetVocabulary -> ByteString #

ToQuery GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

toQuery :: GetVocabulary -> QueryString #

AWSRequest GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Associated Types

type AWSResponse GetVocabulary #

Methods

request :: (Service -> Service) -> GetVocabulary -> Request GetVocabulary #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetVocabulary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVocabulary))) #

Generic GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Associated Types

type Rep GetVocabulary :: Type -> Type #

Methods

from :: GetVocabulary -> Rep GetVocabulary x #

to :: Rep GetVocabulary x -> GetVocabulary #

Read GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

readsPrec :: Int -> ReadS GetVocabulary #

readList :: ReadS [GetVocabulary] #

readPrec :: ReadPrec GetVocabulary #

readListPrec :: ReadPrec [GetVocabulary] #

Show GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

showsPrec :: Int -> GetVocabulary -> ShowS #

show :: GetVocabulary -> String #

showList :: [GetVocabulary] -> ShowS #

NFData GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

rnf :: GetVocabulary -> () #

Eq GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

(==) :: GetVocabulary -> GetVocabulary -> Bool #

(/=) :: GetVocabulary -> GetVocabulary -> Bool #

Hashable GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

hashWithSalt :: Int -> GetVocabulary -> Int #

hash :: GetVocabulary -> Int #

type AWSResponse GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

type AWSResponse GetVocabulary = GetVocabularyResponse
type Rep GetVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

type Rep GetVocabulary = D1 ('MetaData "GetVocabulary" "Amazonka.Transcribe.GetVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "GetVocabulary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetVocabulary Source #

Arguments

:: Text

GetVocabulary

-> GetVocabulary 

Create a value of GetVocabulary 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:

GetVocabulary, getVocabulary_vocabularyName - The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

Request Lenses

getVocabulary_vocabularyName :: Lens' GetVocabulary Text Source #

The name of the custom vocabulary you want information about. Custom vocabulary names are case sensitive.

Destructuring the Response

data GetVocabularyResponse Source #

See: newGetVocabularyResponse smart constructor.

Constructors

GetVocabularyResponse' 

Fields

  • downloadUri :: Maybe Text

    The S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

  • failureReason :: Maybe Text

    If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

  • languageCode :: Maybe LanguageCode

    The language code you selected for your custom vocabulary.

  • 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

    The name of the custom vocabulary you requested information about.

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Associated Types

type Rep GetVocabularyResponse :: Type -> Type #

Methods

from :: GetVocabularyResponse -> Rep GetVocabularyResponse x #

to :: Rep GetVocabularyResponse x -> GetVocabularyResponse #

Read GetVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

readsPrec :: Int -> ReadS GetVocabularyResponse #

readList :: ReadS [GetVocabularyResponse] #

readPrec :: ReadPrec GetVocabularyResponse #

readListPrec :: ReadPrec [GetVocabularyResponse] #

Show GetVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

showsPrec :: Int -> GetVocabularyResponse -> ShowS #

show :: GetVocabularyResponse -> String #

showList :: [GetVocabularyResponse] -> ShowS #

NFData GetVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

rnf :: GetVocabularyResponse -> () #

Eq GetVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

Methods

(==) :: GetVocabularyResponse -> GetVocabularyResponse -> Bool #

(/=) :: GetVocabularyResponse -> GetVocabularyResponse -> Bool #

type Rep GetVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.GetVocabulary

type Rep GetVocabularyResponse = D1 ('MetaData "GetVocabularyResponse" "Amazonka.Transcribe.GetVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "GetVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "downloadUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetVocabularyResponse Source #

Arguments

:: Int

$sel:httpStatus:GetVocabularyResponse'

-> GetVocabularyResponse 

Create a value of GetVocabularyResponse 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:downloadUri:GetVocabularyResponse', getVocabularyResponse_downloadUri - The S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

GetVocabularyResponse, getVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

GetVocabularyResponse, getVocabularyResponse_languageCode - The language code you selected for your custom vocabulary.

GetVocabularyResponse, getVocabularyResponse_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.

GetVocabulary, getVocabularyResponse_vocabularyName - The name of the custom vocabulary you requested information about.

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

$sel:httpStatus:GetVocabularyResponse', getVocabularyResponse_httpStatus - The response's http status code.

Response Lenses

getVocabularyResponse_downloadUri :: Lens' GetVocabularyResponse (Maybe Text) Source #

The S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

getVocabularyResponse_failureReason :: Lens' GetVocabularyResponse (Maybe Text) Source #

If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

getVocabularyResponse_languageCode :: Lens' GetVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary.

getVocabularyResponse_lastModifiedTime :: Lens' GetVocabularyResponse (Maybe UTCTime) Source #

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.

getVocabularyResponse_vocabularyName :: Lens' GetVocabularyResponse (Maybe Text) Source #

The name of the custom vocabulary you requested information about.

getVocabularyResponse_vocabularyState :: Lens' GetVocabularyResponse (Maybe VocabularyState) Source #

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

getVocabularyResponse_httpStatus :: Lens' GetVocabularyResponse Int Source #

The response's http status code.