Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transcribe.ListLanguageModels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned.

To get detailed information about a specific custom language model, use the operation.

Synopsis

data ListLanguageModels = ListLanguageModels' {
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- statusEquals :: Maybe ModelStatus
}
newListLanguageModels :: ListLanguageModels
listLanguageModels_maxResults :: Lens' ListLanguageModels (Maybe Natural)
listLanguageModels_nameContains :: Lens' ListLanguageModels (Maybe Text)
listLanguageModels_nextToken :: Lens' ListLanguageModels (Maybe Text)
listLanguageModels_statusEquals :: Lens' ListLanguageModels (Maybe ModelStatus)
data ListLanguageModelsResponse = ListLanguageModelsResponse' {
- models :: Maybe [LanguageModel]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListLanguageModelsResponse :: Int -> ListLanguageModelsResponse
listLanguageModelsResponse_models :: Lens' ListLanguageModelsResponse (Maybe [LanguageModel])
listLanguageModelsResponse_nextToken :: Lens' ListLanguageModelsResponse (Maybe Text)
listLanguageModelsResponse_httpStatus :: Lens' ListLanguageModelsResponse Int

Creating a Request

data ListLanguageModels Source #

See: newListLanguageModels smart constructor.

Constructors

ListLanguageModels'

Fields

maxResults :: Maybe Natural
The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
nameContains :: Maybe Text
Returns only the custom language models that contain the specified string. The search is not case sensitive.
nextToken :: Maybe Text
If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
statusEquals :: Maybe ModelStatus
Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.

Instances

Instances details

ToJSON ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods toJSON :: ListLanguageModels -> Value # toEncoding :: ListLanguageModels -> Encoding # toJSONList :: [ListLanguageModels] -> Value # toEncodingList :: [ListLanguageModels] -> Encoding #
ToHeaders ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods toHeaders :: ListLanguageModels -> [Header] #
ToPath ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods toPath :: ListLanguageModels -> ByteString #
ToQuery ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods toQuery :: ListLanguageModels -> QueryString #
AWSRequest ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Associated Types type AWSResponse ListLanguageModels # Methods request :: (Service -> Service) -> ListLanguageModels -> Request ListLanguageModels # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListLanguageModels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListLanguageModels))) #
Generic ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Associated Types type Rep ListLanguageModels :: Type -> Type # Methods from :: ListLanguageModels -> Rep ListLanguageModels x # to :: Rep ListLanguageModels x -> ListLanguageModels #
Read ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods readsPrec :: Int -> ReadS ListLanguageModels # readList :: ReadS [ListLanguageModels] # readPrec :: ReadPrec ListLanguageModels # readListPrec :: ReadPrec [ListLanguageModels] #
Show ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods showsPrec :: Int -> ListLanguageModels -> ShowS # show :: ListLanguageModels -> String # showList :: [ListLanguageModels] -> ShowS #
NFData ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods rnf :: ListLanguageModels -> () #
Eq ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods (==) :: ListLanguageModels -> ListLanguageModels -> Bool # (/=) :: ListLanguageModels -> ListLanguageModels -> Bool #
Hashable ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods hashWithSalt :: Int -> ListLanguageModels -> Int # hash :: ListLanguageModels -> Int #
type AWSResponse ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels type AWSResponse ListLanguageModels = ListLanguageModelsResponse
type Rep ListLanguageModels Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels type Rep ListLanguageModels = D1 ('MetaData "ListLanguageModels" "Amazonka.Transcribe.ListLanguageModels" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListLanguageModels'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelStatus)))))

newListLanguageModels :: ListLanguageModels Source #

Create a value of ListLanguageModels 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:maxResults:ListLanguageModels', listLanguageModels_maxResults - The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

$sel:nameContains:ListLanguageModels', listLanguageModels_nameContains - Returns only the custom language models that contain the specified string. The search is not case sensitive.

ListLanguageModels, listLanguageModels_nextToken - If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

$sel:statusEquals:ListLanguageModels', listLanguageModels_statusEquals - Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.

Request Lenses

listLanguageModels_maxResults :: Lens' ListLanguageModels (Maybe Natural) Source #

The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.

listLanguageModels_nameContains :: Lens' ListLanguageModels (Maybe Text) Source #

Returns only the custom language models that contain the specified string. The search is not case sensitive.

listLanguageModels_nextToken :: Lens' ListLanguageModels (Maybe Text) Source #

If your ListLanguageModels request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

listLanguageModels_statusEquals :: Lens' ListLanguageModels (Maybe ModelStatus) Source #

Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.

Destructuring the Response

data ListLanguageModelsResponse Source #

See: newListLanguageModelsResponse smart constructor.

Constructors

ListLanguageModelsResponse'

Fields

models :: Maybe [LanguageModel]
Provides information about the custom language models that match the criteria specified in your request.
nextToken :: Maybe Text
If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListLanguageModelsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Associated Types type Rep ListLanguageModelsResponse :: Type -> Type # Methods from :: ListLanguageModelsResponse -> Rep ListLanguageModelsResponse x # to :: Rep ListLanguageModelsResponse x -> ListLanguageModelsResponse #
Read ListLanguageModelsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods readsPrec :: Int -> ReadS ListLanguageModelsResponse # readList :: ReadS [ListLanguageModelsResponse] # readPrec :: ReadPrec ListLanguageModelsResponse # readListPrec :: ReadPrec [ListLanguageModelsResponse] #
Show ListLanguageModelsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods showsPrec :: Int -> ListLanguageModelsResponse -> ShowS # show :: ListLanguageModelsResponse -> String # showList :: [ListLanguageModelsResponse] -> ShowS #
NFData ListLanguageModelsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods rnf :: ListLanguageModelsResponse -> () #
Eq ListLanguageModelsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels Methods (==) :: ListLanguageModelsResponse -> ListLanguageModelsResponse -> Bool # (/=) :: ListLanguageModelsResponse -> ListLanguageModelsResponse -> Bool #
type Rep ListLanguageModelsResponse Source #
Instance details Defined in Amazonka.Transcribe.ListLanguageModels type Rep ListLanguageModelsResponse = D1 ('MetaData "ListLanguageModelsResponse" "Amazonka.Transcribe.ListLanguageModels" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListLanguageModelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "models") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LanguageModel])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListLanguageModelsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListLanguageModelsResponse'`
-> ListLanguageModelsResponse

Create a value of ListLanguageModelsResponse 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:models:ListLanguageModelsResponse', listLanguageModelsResponse_models - Provides information about the custom language models that match the criteria specified in your request.

ListLanguageModels, listLanguageModelsResponse_nextToken - If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

$sel:httpStatus:ListLanguageModelsResponse', listLanguageModelsResponse_httpStatus - The response's http status code.

Response Lenses

listLanguageModelsResponse_models :: Lens' ListLanguageModelsResponse (Maybe [LanguageModel]) Source #

Provides information about the custom language models that match the criteria specified in your request.

listLanguageModelsResponse_nextToken :: Lens' ListLanguageModelsResponse (Maybe Text) Source #

If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

listLanguageModelsResponse_httpStatus :: Lens' ListLanguageModelsResponse Int Source #

The response's http status code.