libZSservicesZSamazonka-transcribeZSamazonka-transcribe
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Transcribe.ListLanguageModels

Description

Provides more information about the custom language models you've created. You can use the information in this list to find a specific custom language model. You can then use the operation to get more information about it.

Synopsis

Creating a Request

data ListLanguageModels Source #

See: newListLanguageModels smart constructor.

Constructors

ListLanguageModels' 

Fields

  • nameContains :: Maybe Text

    When specified, the custom language model names returned contain the substring you've specified.

  • nextToken :: Maybe Text

    When included, fetches the next set of jobs if the result of the previous request was truncated.

  • statusEquals :: Maybe ModelStatus

    When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.

  • maxResults :: Maybe Natural

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

Instances

Instances details
Eq ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Read ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Show ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Generic ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Associated Types

type Rep ListLanguageModels :: Type -> Type #

NFData ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Methods

rnf :: ListLanguageModels -> () #

Hashable ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

ToJSON ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

AWSRequest ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Associated Types

type AWSResponse ListLanguageModels #

ToHeaders ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

ToPath ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

ToQuery ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

type Rep ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

type Rep ListLanguageModels = D1 ('MetaData "ListLanguageModels" "Amazonka.Transcribe.ListLanguageModels" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListLanguageModels'" 'PrefixI 'True) ((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)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListLanguageModels Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

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:nameContains:ListLanguageModels', listLanguageModels_nameContains - When specified, the custom language model names returned contain the substring you've specified.

$sel:nextToken:ListLanguageModels', listLanguageModels_nextToken - When included, fetches the next set of jobs if the result of the previous request was truncated.

$sel:statusEquals:ListLanguageModels', listLanguageModels_statusEquals - When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.

$sel:maxResults:ListLanguageModels', listLanguageModels_maxResults - The maximum number of language models to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Request Lenses

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

When specified, the custom language model names returned contain the substring you've specified.

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

When included, fetches the next set of jobs if the result of the previous request was truncated.

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

When specified, returns only custom language models with the specified status. Language models are ordered by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language models ordered by date.

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

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

Destructuring the Response

data ListLanguageModelsResponse Source #

See: newListLanguageModelsResponse smart constructor.

Constructors

ListLanguageModelsResponse' 

Fields

  • nextToken :: Maybe Text

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

  • models :: Maybe [LanguageModel]

    A list of objects containing information about custom language models.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListLanguageModelsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Read ListLanguageModelsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Show ListLanguageModelsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Generic ListLanguageModelsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

Associated Types

type Rep ListLanguageModelsResponse :: Type -> Type #

NFData ListLanguageModelsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

type Rep ListLanguageModelsResponse Source # 
Instance details

Defined in Amazonka.Transcribe.ListLanguageModels

type Rep ListLanguageModelsResponse = D1 ('MetaData "ListLanguageModelsResponse" "Amazonka.Transcribe.ListLanguageModels" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListLanguageModelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "models") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LanguageModel])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListLanguageModelsResponse Source #

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:nextToken:ListLanguageModels', listLanguageModelsResponse_nextToken - The operation returns a page of jobs at a time. The maximum size of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the operation to return the next page of language models.

$sel:models:ListLanguageModelsResponse', listLanguageModelsResponse_models - A list of objects containing information about custom language models.

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

Response Lenses

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

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

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

A list of objects containing information about custom language models.