[ aws . lex-models ]

get-export

Description

Exports the contents of a Amazon Lex resource in a specified format.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-export
--name <value>
--resource-type <value>
--export-type <value>
--resource-version <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

The name of the bot to export.

--resource-type (string)

The type of resource to export.

Possible values:

  • BOT

  • INTENT

  • SLOT_TYPE

--export-type (string)

The format of the exported data.

Possible values:

  • ALEXA_SKILLS_KIT

  • LEX

--resource-version (string)

The version of the bot to export.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

name -> (string)

The name of the bot being exported.

version -> (string)

The version of the bot being exported.

resourceType -> (string)

The type of the exported resource.

exportType -> (string)

The format of the exported data.

exportStatus -> (string)

The status of the export.

  • IN_PROGRESS - The export is in progress.

  • READY - The export is complete.

  • FAILED - The export could not be completed.

failureReason -> (string)

If status is FAILED , Amazon Lex provides the reason that it failed to export the resource.

url -> (string)

An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.