DescribeLanguageModel
Provides information about the specified custom language model.
This operation also shows if the base language model that you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful,
you can use DescribeLanguageModel to help identify the reason for this
failure.
To get a list of your custom language models, use the ListLanguageModels operation.
Request Syntax
{
"ModelName": "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.
- ModelName
-
The name of the custom language model you want information about. Model names are case sensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z._-]+Required: Yes
Response Syntax
{
"LanguageModel": {
"BaseModelName": "string",
"CreateTime": number,
"EncryptionConfiguration": {
"KMSEncryptionContext": {
"string" : "string"
},
"KMSKey": "string"
},
"FailureReason": "string",
"InputDataConfig": {
"DataAccessRoleArn": "string",
"S3Uri": "string",
"TuningDataS3Uri": "string"
},
"LanguageCode": "string",
"LastModifiedTime": number,
"ModelName": "string",
"ModelStatus": "string",
"UpgradeAvailability": boolean
}
}
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.
- LanguageModel
-
Provides information about the specified custom language model.
This parameter also shows if the base language model you used to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a new custom language model using the updated base model.
If you tried to create a new custom language model and the request wasn't successful, you can use this
DescribeLanguageModelto help identify the reason for this failure.Type: LanguageModel object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- BadRequestException
-
Your request didn't pass one or more validation tests. This can occur when a parameter has an invalid value, when you combine parameters in a way that isn't supported, when the entity you're trying to delete doesn't exist, or if it's in a non-terminal state (such as
IN PROGRESS). See the exception message field for more information.- Reason
-
A code that identifies why the audio in your request was rejected. Currently,
TranscribeAudioreturns this field, and only for problems with your audio. It isn't returned for other validation errors.Possible values:
-
audioTooLong: The audio is longer than the maximum duration of 1 hour. -
audioTooShort: The audio is shorter than 0.5 seconds. -
audioFileTooLarge: The audio is larger than the maximum size. -
unsupportedAudioFormat: The media format isn't supported. -
unsupportedChannelCount: You enabledChannelIdentificationand the audio has more than two channels. -
invalidAudio: Amazon Transcribe couldn't decode the audio. -
mediaDownloadFailed: Amazon Transcribe couldn't download the audio at yourMediaFileUri.
-
HTTP Status Code: 400
- InternalFailureException
-
There was an internal error. Check the error message, correct the issue, and try your request again.
HTTP Status Code: 500
- LimitExceededException
-
You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.
HTTP Status Code: 400
- NotFoundException
-
We can't find the requested resource. Check that the specified name is correct and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: