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

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"
      },
      "customVocabularyExportSpecification": { 
         "botId": "string",
         "botVersion": "string",
         "localeId": "string"
      },
      "testSetExportSpecification": { 
         "testSetId": "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