CreateExportCommand

Suggest an Edit

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots  

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { LexModelsV2Client, CreateExportCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, CreateExportCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // CreateExportRequest
  resourceSpecification: { // ExportResourceSpecification
    botExportSpecification: { // BotExportSpecification
      botId: "STRING_VALUE", // required
      botVersion: "STRING_VALUE", // required
    },
    botLocaleExportSpecification: { // BotLocaleExportSpecification
      botId: "STRING_VALUE", // required
      botVersion: "STRING_VALUE", // required
      localeId: "STRING_VALUE", // required
    },
    customVocabularyExportSpecification: { // CustomVocabularyExportSpecification
      botId: "STRING_VALUE", // required
      botVersion: "STRING_VALUE", // required
      localeId: "STRING_VALUE", // required
    },
    testSetExportSpecification: { // TestSetExportSpecification
      testSetId: "STRING_VALUE", // required
    },
  },
  fileFormat: "LexJson" || "TSV" || "CSV", // required
  filePassword: "STRING_VALUE",
};
const command = new CreateExportCommand(input);
const response = await client.send(command);
// { // CreateExportResponse
//   exportId: "STRING_VALUE",
//   resourceSpecification: { // ExportResourceSpecification
//     botExportSpecification: { // BotExportSpecification
//       botId: "STRING_VALUE", // required
//       botVersion: "STRING_VALUE", // required
//     },
//     botLocaleExportSpecification: { // BotLocaleExportSpecification
//       botId: "STRING_VALUE", // required
//       botVersion: "STRING_VALUE", // required
//       localeId: "STRING_VALUE", // required
//     },
//     customVocabularyExportSpecification: { // CustomVocabularyExportSpecification
//       botId: "STRING_VALUE", // required
//       botVersion: "STRING_VALUE", // required
//       localeId: "STRING_VALUE", // required
//     },
//     testSetExportSpecification: { // TestSetExportSpecification
//       testSetId: "STRING_VALUE", // required
//     },
//   },
//   fileFormat: "LexJson" || "TSV" || "CSV",
//   exportStatus: "InProgress" || "Completed" || "Failed" || "Deleting",
//   creationDateTime: new Date("TIMESTAMP"),
// };

CreateExportCommand Input

See CreateExportCommandInput for more details

Parameter
Type
Description
fileFormat
Required
ImportExportFileFormat | undefined

The file format of the bot or bot locale definition files.

resourceSpecification
Required
ExportResourceSpecification | undefined

Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

filePassword
string | undefined

An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.

CreateExportCommand Output

See CreateExportCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationDateTime
Date | undefined

The date and time that the request to export a bot was created.

exportId
string | undefined

An identifier for a specific request to create an export.

exportStatus
ExportStatus | undefined

The status of the export. When the status is Completed, you can use the DescribeExport  operation to get the pre-signed S3 URL link to your exported bot or bot locale.

fileFormat
ImportExportFileFormat | undefined

The file format used for the bot or bot locale definition files.

resourceSpecification
ExportResourceSpecification | undefined

A description of the type of resource that was exported, either a bot or a bot locale.

Throws

Name
Fault
Details
ConflictException
client

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

InternalServerException
server

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

ResourceNotFoundException
client

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

ServiceQuotaExceededException
client

You have reached a quota for your bot.

ThrottlingException
client

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

ValidationException
client

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

LexModelsV2ServiceException
Base exception class for all service exceptions from LexModelsV2 service.