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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a vocabulary.

Synopsis

data GetVocabulary = GetVocabulary' {
- vocabularyName :: Text
}
newGetVocabulary :: Text -> GetVocabulary
getVocabulary_vocabularyName :: Lens' GetVocabulary Text
data GetVocabularyResponse = GetVocabularyResponse' {
- failureReason :: Maybe Text
- languageCode :: Maybe LanguageCode
- downloadUri :: Maybe Text
- vocabularyName :: Maybe Text
- lastModifiedTime :: Maybe POSIX
- vocabularyState :: Maybe VocabularyState
- httpStatus :: Int
}
newGetVocabularyResponse :: Int -> GetVocabularyResponse
getVocabularyResponse_failureReason :: Lens' GetVocabularyResponse (Maybe Text)
getVocabularyResponse_languageCode :: Lens' GetVocabularyResponse (Maybe LanguageCode)
getVocabularyResponse_downloadUri :: Lens' GetVocabularyResponse (Maybe Text)
getVocabularyResponse_vocabularyName :: Lens' GetVocabularyResponse (Maybe Text)
getVocabularyResponse_lastModifiedTime :: Lens' GetVocabularyResponse (Maybe UTCTime)
getVocabularyResponse_vocabularyState :: Lens' GetVocabularyResponse (Maybe VocabularyState)
getVocabularyResponse_httpStatus :: Lens' GetVocabularyResponse Int

Creating a Request

data GetVocabulary Source #

See: newGetVocabulary smart constructor.

Constructors

GetVocabulary'
Fields vocabularyName :: Text The name of the vocabulary to return information about. The name is case sensitive.

Instances

Instances details

Eq GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Methods (==) :: GetVocabulary -> GetVocabulary -> Bool # (/=) :: GetVocabulary -> GetVocabulary -> Bool #
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 #
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 #
NFData GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Methods rnf :: GetVocabulary -> () #
Hashable GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Methods hashWithSalt :: Int -> GetVocabulary -> Int # hash :: GetVocabulary -> Int #
ToJSON GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Methods toJSON :: GetVocabulary -> Value # toEncoding :: GetVocabulary -> Encoding # toJSONList :: [GetVocabulary] -> Value # toEncodingList :: [GetVocabulary] -> Encoding #
AWSRequest GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Associated Types type AWSResponse GetVocabulary # Methods request :: GetVocabulary -> Request GetVocabulary # response :: MonadResource m => Logger -> Service -> Proxy GetVocabulary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVocabulary))) #
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 #
type Rep GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary type Rep GetVocabulary = D1 ('MetaData "GetVocabulary" "Amazonka.Transcribe.GetVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "GetVocabulary'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetVocabulary Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary type AWSResponse GetVocabulary = GetVocabularyResponse

newGetVocabulary Source #

Arguments

:: Text	`$sel:vocabularyName: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:

$sel:vocabularyName:GetVocabulary', getVocabulary_vocabularyName - The name of the vocabulary to return information about. The name is case sensitive.

Request Lenses

getVocabulary_vocabularyName :: Lens' GetVocabulary Text Source #

The name of the vocabulary to return information about. The name is case sensitive.

Destructuring the Response

data GetVocabularyResponse Source #

See: newGetVocabularyResponse smart constructor.

Constructors

GetVocabularyResponse'

Fields

failureReason :: Maybe Text
If the VocabularyState field is FAILED, this field contains information about why the job failed.
languageCode :: Maybe LanguageCode
The language code of the vocabulary entries.
downloadUri :: Maybe Text
The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
vocabularyName :: Maybe Text
The name of the vocabulary to return.
lastModifiedTime :: Maybe POSIX
The date and time that the vocabulary was last modified.
vocabularyState :: Maybe VocabularyState
The processing state of the vocabulary.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Methods (==) :: GetVocabularyResponse -> GetVocabularyResponse -> Bool # (/=) :: GetVocabularyResponse -> GetVocabularyResponse -> Bool #
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 #
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 #
NFData GetVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary Methods rnf :: GetVocabularyResponse -> () #
type Rep GetVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetVocabulary type Rep GetVocabularyResponse = D1 ('MetaData "GetVocabularyResponse" "Amazonka.Transcribe.GetVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "GetVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: S1 ('MetaSel ('Just "downloadUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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)))))

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:failureReason:GetVocabularyResponse', getVocabularyResponse_failureReason - If the VocabularyState field is FAILED, this field contains information about why the job failed.

$sel:languageCode:GetVocabularyResponse', getVocabularyResponse_languageCode - The language code of the vocabulary entries.

$sel:downloadUri:GetVocabularyResponse', getVocabularyResponse_downloadUri - The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.

$sel:vocabularyName:GetVocabulary', getVocabularyResponse_vocabularyName - The name of the vocabulary to return.

$sel:lastModifiedTime:GetVocabularyResponse', getVocabularyResponse_lastModifiedTime - The date and time that the vocabulary was last modified.

$sel:vocabularyState:GetVocabularyResponse', getVocabularyResponse_vocabularyState - The processing state of the vocabulary.

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