ListLanguageModels - Amazon Transcribe

ListLanguageModels

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 DescribeLanguageModel operation to get more information about it.

Request Syntax

{ "MaxResults": number, "NameContains": "string", "NextToken": "string", "StatusEquals": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Required: No

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.

Type: String

Valid Values: IN_PROGRESS | FAILED | COMPLETED

Required: No

Response Syntax

{ "Models": [ { "BaseModelName": "string", "CreateTime": number, "FailureReason": "string", "InputDataConfig": { "DataAccessRoleArn": "string", "S3Uri": "string", "TuningDataS3Uri": "string" }, "LanguageCode": "string", "LastModifiedTime": number, "ModelName": "string", "ModelStatus": "string", "UpgradeAvailability": boolean } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Models

A list of objects containing information about custom language models.

Type: Array of LanguageModel objects

NextToken

The ListLanguageModels 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 ListLanguageModels operation to return the next page of language models.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

HTTP Status Code: 400

InternalFailureException

There was an internal error. Check the error message and try your request again.

HTTP Status Code: 500

LimitExceededException

Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: