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

Synopsis¶

  create-export
--resource-specification <value>
--file-format <value>
[--file-password <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

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.

testSetExportSpecification -> (structure)

Specifications for the test set that is exported as a resource.

testSetId -> (string)

The unique identifier of the test set.

Shorthand Syntax:

botExportSpecification={botId=string,botVersion=string},botLocaleExportSpecification={botId=string,botVersion=string,localeId=string},customVocabularyExportSpecification={botId=string,botVersion=string,localeId=string},testSetExportSpecification={testSetId=string}

JSON Syntax:

{
  "botExportSpecification": {
    "botId": "string",
    "botVersion": "string"
  },
  "botLocaleExportSpecification": {
    "botId": "string",
    "botVersion": "string",
    "localeId": "string"
  },
  "customVocabularyExportSpecification": {
    "botId": "string",
    "botVersion": "string",
    "localeId": "string"
  },
  "testSetExportSpecification": {
    "testSetId": "string"
  }
}

--file-format (string)

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

Possible values:

LexJson

TSV

CSV

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

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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.

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.

testSetExportSpecification -> (structure)

Specifications for the test set that is exported as a resource.

testSetId -> (string)

The unique identifier of the test set.

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

Table of Contents

Feedback

User Guide