DescribeExportCommand

Suggest an Edit

Gets information about a specific export.

Example Syntax

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

import { LexModelsV2Client, DescribeExportCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
// const { LexModelsV2Client, DescribeExportCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
const client = new LexModelsV2Client(config);
const input = { // DescribeExportRequest
  exportId: "STRING_VALUE", // required
};
const command = new DescribeExportCommand(input);
const response = await client.send(command);
// { // DescribeExportResponse
//   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",
//   failureReasons: [ // FailureReasons
//     "STRING_VALUE",
//   ],
//   downloadUrl: "STRING_VALUE",
//   creationDateTime: new Date("TIMESTAMP"),
//   lastUpdatedDateTime: new Date("TIMESTAMP"),
// };

DescribeExportCommand Input

See DescribeExportCommandInput for more details

Parameter
Type
Description
exportId
Required
string | undefined

The unique identifier of the export to describe.

DescribeExportCommand Output

See DescribeExportCommandOutput for details

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

The date and time that the export was created.

downloadUrl
string | undefined

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.

exportId
string | undefined

The unique identifier of the described export.

exportStatus
ExportStatus | undefined

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

failureReasons
string[] | undefined

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

fileFormat
ImportExportFileFormat | undefined

The file format used in the files that describe the resource.

lastUpdatedDateTime
Date | undefined

The last date and time that the export was updated.

resourceSpecification
ExportResourceSpecification | undefined

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

Throws

Name
Fault
Details
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.

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.