DescribeExport - Amazon Lex

DescribeExport

Gets information about a specific export.

Request Syntax

GET /exports/exportId/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

exportId

The unique identifier of the export to describe.

Length Constraints: Fixed length of 10.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "creationDateTime": number, "downloadUrl": "string", "exportId": "string", "exportStatus": "string", "failureReasons": [ "string" ], "fileFormat": "string", "lastUpdatedDateTime": number, "resourceSpecification": { "botExportSpecification": { "botId": "string", "botVersion": "string" }, "botLocaleExportSpecification": { "botId": "string", "botVersion": "string", "localeId": "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.

creationDateTime

The date and time that the export was created.

Type: Timestamp

downloadUrl

A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

Type: String

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

exportId

The unique identifier of the described export.

Type: String

Length Constraints: Fixed length of 10.

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

exportStatus

The status of the export. When the status is Complete the export archive file is available for download.

Type: String

Valid Values: InProgress | Completed | Failed | Deleting

failureReasons

If the exportStatus is failed, contains one or more reasons why the export could not be completed.

Type: Array of strings

fileFormat

The file format used in the files that describe the bot or bot locale.

Type: String

Valid Values: LexJson

lastUpdatedDateTime

The last date and time that the export was updated.

Type: Timestamp

resourceSpecification

The bot, bot ID, and optional locale ID of the exported bot or bot locale.

Type: ExportResourceSpecification object

Errors

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

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters 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: