Network.AWS.Transcribe.ListVocabularies

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Creating a Request

listVocabularies :: ListVocabularies

Creates a value of ListVocabularies with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lvNameContains - When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and VocabularyName in the response list.
• lvNextToken - If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
• lvStateEquals - When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
• lvMaxResults - The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

data ListVocabularies

See: listVocabularies smart constructor.

Instances

Eq ListVocabularies

Methods

(==) :: ListVocabularies -> ListVocabularies -> Bool

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

Data ListVocabularies

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListVocabularies -> c ListVocabularies

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListVocabularies

toConstr :: ListVocabularies -> Constr

dataTypeOf :: ListVocabularies -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListVocabularies)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListVocabularies)

gmapT :: (forall b. Data b => b -> b) -> ListVocabularies -> ListVocabularies

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListVocabularies -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListVocabularies -> r

gmapQ :: (forall d. Data d => d -> u) -> ListVocabularies -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListVocabularies -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListVocabularies -> m ListVocabularies

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVocabularies -> m ListVocabularies

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVocabularies -> m ListVocabularies

Read ListVocabularies

Methods

readsPrec :: Int -> ReadS ListVocabularies

readList :: ReadS [ListVocabularies]

readPrec :: ReadPrec ListVocabularies

readListPrec :: ReadPrec [ListVocabularies]

Show ListVocabularies

Methods

showsPrec :: Int -> ListVocabularies -> ShowS

show :: ListVocabularies -> String

showList :: [ListVocabularies] -> ShowS

Generic ListVocabularies

Associated Types

type Rep ListVocabularies :: * -> *

Methods

from :: ListVocabularies -> Rep ListVocabularies x

to :: Rep ListVocabularies x -> ListVocabularies

Hashable ListVocabularies

Methods

hashWithSalt :: Int -> ListVocabularies -> Int

hash :: ListVocabularies -> Int

ToJSON ListVocabularies

Methods

toJSON :: ListVocabularies -> Value

toEncoding :: ListVocabularies -> Encoding

toJSONList :: [ListVocabularies] -> Value

toEncodingList :: [ListVocabularies] -> Encoding

NFData ListVocabularies

Methods

rnf :: ListVocabularies -> ()

AWSRequest ListVocabularies

Associated Types

type Rs ListVocabularies :: *

Methods

request :: ListVocabularies -> Request ListVocabularies

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListVocabularies -> ClientResponse -> m (Response ListVocabularies)

ToHeaders ListVocabularies

Methods

toHeaders :: ListVocabularies -> [Header]

ToPath ListVocabularies

Methods

toPath :: ListVocabularies -> ByteString

ToQuery ListVocabularies

Methods

toQuery :: ListVocabularies -> QueryString

type Rep ListVocabularies

type Rep ListVocabularies = D1 * (MetaData "ListVocabularies" "Network.AWS.Transcribe.ListVocabularies" "amazonka-transcribe-1.6.0-EAJHmFqYXYhFnJ8LH2D7KC" False) (C1 * (MetaCons "ListVocabularies'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lvNameContains") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lvNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lvStateEquals") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VocabularyState))) (S1 * (MetaSel (Just Symbol "_lvMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs ListVocabularies

type Rs ListVocabularies = ListVocabulariesResponse

Request Lenses

lvNameContains :: Lens' ListVocabularies (Maybe Text)

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both "vocabularyname" and VocabularyName in the response list.

lvNextToken :: Lens' ListVocabularies (Maybe Text)

If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

lvStateEquals :: Lens' ListVocabularies (Maybe VocabularyState)

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

lvMaxResults :: Lens' ListVocabularies (Maybe Natural)

The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

Destructuring the Response

listVocabulariesResponse

Arguments

:: Int

lvrsResponseStatus

-> ListVocabulariesResponse

Creates a value of ListVocabulariesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lvrsVocabularies - A list of objects that describe the vocabularies that match the search criteria in the request.
• lvrsStatus - The requested vocabulary state.
• lvrsNextToken - The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularies operation to return in the next page of jobs.
• lvrsResponseStatus - -- | The response status code.

data ListVocabulariesResponse

See: listVocabulariesResponse smart constructor.

Instances

Eq ListVocabulariesResponse

Methods

(==) :: ListVocabulariesResponse -> ListVocabulariesResponse -> Bool

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

Data ListVocabulariesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListVocabulariesResponse -> c ListVocabulariesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListVocabulariesResponse

toConstr :: ListVocabulariesResponse -> Constr

dataTypeOf :: ListVocabulariesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListVocabulariesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListVocabulariesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListVocabulariesResponse -> ListVocabulariesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListVocabulariesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListVocabulariesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListVocabulariesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListVocabulariesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListVocabulariesResponse -> m ListVocabulariesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVocabulariesResponse -> m ListVocabulariesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListVocabulariesResponse -> m ListVocabulariesResponse

Read ListVocabulariesResponse

Methods

readsPrec :: Int -> ReadS ListVocabulariesResponse

readList :: ReadS [ListVocabulariesResponse]

readPrec :: ReadPrec ListVocabulariesResponse

readListPrec :: ReadPrec [ListVocabulariesResponse]

Show ListVocabulariesResponse

Methods

showsPrec :: Int -> ListVocabulariesResponse -> ShowS

show :: ListVocabulariesResponse -> String

showList :: [ListVocabulariesResponse] -> ShowS

Generic ListVocabulariesResponse

Associated Types

type Rep ListVocabulariesResponse :: * -> *

Methods

from :: ListVocabulariesResponse -> Rep ListVocabulariesResponse x

to :: Rep ListVocabulariesResponse x -> ListVocabulariesResponse

NFData ListVocabulariesResponse

Methods

rnf :: ListVocabulariesResponse -> ()

type Rep ListVocabulariesResponse

type Rep ListVocabulariesResponse = D1 * (MetaData "ListVocabulariesResponse" "Network.AWS.Transcribe.ListVocabularies" "amazonka-transcribe-1.6.0-EAJHmFqYXYhFnJ8LH2D7KC" False) (C1 * (MetaCons "ListVocabulariesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_lvrsVocabularies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [VocabularyInfo]))) (S1 * (MetaSel (Just Symbol "_lvrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TranscriptionJobStatus)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lvrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_lvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lvrsVocabularies :: Lens' ListVocabulariesResponse [VocabularyInfo]

A list of objects that describe the vocabularies that match the search criteria in the request.

lvrsStatus :: Lens' ListVocabulariesResponse (Maybe TranscriptionJobStatus)

The requested vocabulary state.

lvrsNextToken :: Lens' ListVocabulariesResponse (Maybe Text)

The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularies operation to return in the next page of jobs.

lvrsResponseStatus :: Lens' ListVocabulariesResponse Int

• - | The response status code.