[ aws . lexv2-models ]

describe-export

Description

Gets information about a specific export.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-export
--export-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--export-id (string)

The unique identifier of the export to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

exportId -> (string)

The unique identifier of the described export.

resourceSpecification -> (structure)

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

botExportSpecification -> (structure)

Parameters for exporting a bot.

botId -> (string)

The identifier of the bot assigned by Amazon Lex.

botVersion -> (string)

The version of the bot that was exported. This will be either DRAFT or the version number.

botLocaleExportSpecification -> (structure)

Parameters for exporting a bot locale.

botId -> (string)

The identifier of the bot to create the locale for.

botVersion -> (string)

The version of the bot to export.

localeId -> (string)

The identifier of the language and locale to export. The string must match one of the locales in the bot.

customVocabularyExportSpecification -> (structure)

The parameters required to export a custom vocabulary.

botId -> (string)

The identifier of the bot that contains the custom vocabulary to export.

botVersion -> (string)

The version of the bot that contains the custom vocabulary to export.

localeId -> (string)

The locale of the bot that contains the custom vocabulary to export.

fileFormat -> (string)

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

exportStatus -> (string)

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

failureReasons -> (list)

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

(string)

downloadUrl -> (string)

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.

creationDateTime -> (timestamp)

The date and time that the export was created.

lastUpdatedDateTime -> (timestamp)

The last date and time that the export was updated.