Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetExport

Exports the contents of a Amazon Lex resource in a specified format.

Request Syntax


GET /exports/?exportType=exportType&name=name&resourceType=resourceType&version=version HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

exportType

The format of the exported data.

Valid Values: ALEXA_SKILLS_KIT | LEX

Required: Yes

name

The name of the bot to export.

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

Pattern: [a-zA-Z_]+

Required: Yes

resourceType

The type of resource to export.

Valid Values: BOT | INTENT | SLOT_TYPE

Required: Yes

version

The version of the bot to export.

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

Pattern: [0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "exportStatus": "string",
   "exportType": "string",
   "failureReason": "string",
   "name": "string",
   "resourceType": "string",
   "url": "string",
   "version": "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.

exportStatus

The status of the export.

IN_PROGRESS - The export is in progress.
READY - The export is complete.
FAILED - The export could not be completed.

Type: String

Valid Values: IN_PROGRESS | READY | FAILED

exportType

The format of the exported data.

Type: String

Valid Values: ALEXA_SKILLS_KIT | LEX

failureReason

If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.

Type: String

name

The name of the bot being exported.

Type: String

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

Pattern: [a-zA-Z_]+

resourceType

The type of the exported resource.

Type: String

Valid Values: BOT | INTENT | SLOT_TYPE

url

An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.

Type: String

version

The version of the bot being exported.

Type: String

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

Pattern: [0-9]+

Errors

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

HTTP Status Code: 400

InternalFailureException

An internal Amazon Lex error occurred. Try your request again.

HTTP Status Code: 500

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

NotFoundException

The resource specified in the request was not found. Check the resource and try again.

HTTP Status Code: 404