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

ListExports

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Request Syntax


POST /exports/ HTTP/1.1
Content-type: application/json

{
   "botId": "string",
   "botVersion": "string",
   "filters": [ 
      { 
         "name": "string",
         "operator": "string",
         "values": [ "string" ]
      }
   ],
   "localeId": "string",
   "maxResults": number,
   "nextToken": "string",
   "sortBy": { 
      "attribute": "string",
      "order": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

botId

The unique identifier that Amazon Lex assigned to the bot.

Type: String

Length Constraints: Fixed length of 10.

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

Required: No

botVersion

The version of the bot to list exports for.

Type: String

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

Pattern: ^(DRAFT|[0-9]+)$

Required: No

filters

Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

Type: Array of ExportFilter objects

Array Members: Fixed number of 1 item.

Required: No

localeId

Specifies the resources that should be exported. If you don't specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.

Type: String

Required: No

maxResults

The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

Type: Integer

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

Required: No

nextToken

If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.

Type: String

Required: No

sortBy

Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

Type: ExportSortBy object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "botId": "string",
   "botVersion": "string",
   "exportSummaries": [ 
      { 
         "creationDateTime": number,
         "exportId": "string",
         "exportStatus": "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"
            }
         }
      }
   ],
   "localeId": "string",
   "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.

botId

The unique identifier assigned to the bot by Amazon Lex.

Type: String

Length Constraints: Fixed length of 10.

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

botVersion

The version of the bot that was exported.

Type: String

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

Pattern: ^(DRAFT|[0-9]+)$

exportSummaries

Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field contains a token to get the next page of results.

Type: Array of ExportSummary objects

localeId

The locale specified in the request.

Type: String

nextToken

A token that indicates whether there are more results to return in a response to the ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.

Type: String

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

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