[ aws . lexv2-models ]

create-export

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-export
--resource-specification <value>
--file-format <value>
[--file-password <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-specification (structure)

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

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.

Shorthand Syntax:

botExportSpecification={botId=string,botVersion=string},botLocaleExportSpecification={botId=string,botVersion=string,localeId=string}

JSON Syntax:

{
  "botExportSpecification": {
    "botId": "string",
    "botVersion": "string"
  },
  "botLocaleExportSpecification": {
    "botId": "string",
    "botVersion": "string",
    "localeId": "string"
  }
}

--file-format (string)

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

Possible values:

• LexJson

--file-password (string)

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.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

exportId -> (string)

An identifier for a specific request to create an export.

resourceSpecification -> (structure)

A description of the type of resource that was exported, either a bot or a 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.

fileFormat -> (string)

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

exportStatus -> (string)

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

creationDateTime -> (timestamp)

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