Amazon Lex Exports API

The exports API from Amazon Lex — 2 operation(s) for exports.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /exports Export a bot or locale to a zip archive · Create Export #
Ask an LLM
“How do I export my Lex bot definition as a zip file of JSON?”
“Can I password-protect a bot export archive?”
Tell an agent
Export {resourceSpecification} as a {fileFormat} archive.
Create a {fileFormat} export of {resourceSpecification} protected with password {filePassword}.
POST /exports List recent bot exports · List Exports #
Ask an LLM
“Which bot exports have I made in the last week?”
“Can I filter exports down to one bot and locale?”
Tell an agent
List my recent exports.
Show exports of bot {botId} version {botVersion} for locale {localeId}.
GET /exports Get Export #
DELETE /exports/{exportId} Delete an export and its files · Delete Export #
Ask an LLM
“How do I delete a previous bot export and its S3 files?”
“Can I clean up an export archive I no longer need?”
Tell an agent destructive · confirm first
Delete export {exportId}.
Remove export {exportId} along with its stored archive.
GET /exports/{exportId} Get an export's status and download link · Describe Export #
Ask an LLM
“Is my bot export finished, and where do I download it?”
“What's the status of a specific export job?”
Tell an agent
Describe export {exportId}.
Get the status and download URL for export {exportId}.
PUT /exports/{exportId} Change the password on an export archive · Update Export #
Ask an LLM
“How do I change the password on a bot export zip?”
“Can I remove password protection from an export I already created?”
Tell an agent
Set the password on export {exportId} to {filePassword}.
Update export {exportId} so its archive is not password protected.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-lex:amazon-lex-exports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-lex-exports-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Lex Model Building V2 Exports API
  version: '2020-08-07'
  description: Generated from AWS's published Smithy model for Amazon Lex Model Building V2. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://models-v2-lex.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /exports:
    put:
      operationId: CreateExport
      summary: 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateExportResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExportRequest'
      tags:
      - Exports
    post:
      operationId: ListExports
      summary: List Exports
      description: Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListExportsResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListExportsRequest'
      tags:
      - Exports
    get:
      operationId: GetExport
      summary: Get Export
      description: Exports the contents of a Amazon Lex resource in a specified format.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetExportResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetExportRequest'
      tags:
      - Exports
      servers:
      - url: https://models.lex.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
  /exports/{exportId}:
    delete:
      operationId: DeleteExport
      summary: Delete Export
      description: Removes a previous export and the associated files stored in an S3 bucket.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteExportResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '412':
          description: PreconditionFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreconditionFailedException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteExportRequest'
      tags:
      - Exports
    get:
      operationId: DescribeExport
      summary: Describe Export
      description: Gets information about a specific export.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeExportResponse'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeExportRequest'
      tags:
      - Exports
    put:
      operationId: UpdateExport
      summary: Update Export
      description: Updates the password used to protect an export zip archive. The password is not required. If you don't
        supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is
        available at the pre-signed S3 URL provided by the DescribeExport operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateExportResponse'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExportRequest'
      tags:
      - Exports
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: lex
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    BotExportSpecification:
      type: object
      properties:
        botId:
          type: string
          description: The identifier of the bot assigned by Amazon Lex.
        botVersion:
          type: string
          description: The version of the bot that was exported. This will be either DRAFT or the version number.
      required:
      - botId
      - botVersion
    BotLocaleExportSpecification:
      type: object
      properties:
        botId:
          type: string
          description: The identifier of the bot to create the locale for.
        botVersion:
          type: string
          description: The version of the bot to export.
        localeId:
          type: string
          description: The identifier of the language and locale to export. The string must match one of the locales in the
            bot.
      required:
      - botId
      - botVersion
      - localeId
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateExportRequest:
      type: object
      properties:
        resourceSpecification:
          $ref: '#/components/schemas/ExportResourceSpecification'
        fileFormat:
          type: string
          enum:
          - LexJson
          - TSV
          - CSV
          description: The file format of the bot or bot locale definition files.
        filePassword:
          type: string
          description: 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.
      required:
      - resourceSpecification
      - fileFormat
    CreateExportResponse:
      type: object
      properties:
        exportId:
          type: string
          description: An identifier for a specific request to create an export.
        resourceSpecification:
          $ref: '#/components/schemas/ExportResourceSpecification'
        fileFormat:
          type: string
          enum:
          - LexJson
          - TSV
          - CSV
          description: The file format used for the bot or bot locale definition files.
        exportStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Deleting
          description: 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:
          type: string
          format: date-time
          description: The date and time that the request to export a bot was created.
    CustomVocabularyExportSpecification:
      type: object
      properties:
        botId:
          type: string
          description: The identifier of the bot that contains the custom vocabulary to export.
        botVersion:
          type: string
          description: The version of the bot that contains the custom vocabulary to export.
        localeId:
          type: string
          description: The locale of the bot that contains the custom vocabulary to export.
      required:
      - botId
      - botVersion
      - localeId
    DeleteExportRequest:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier of the export to delete.
      required:
      - exportId
    DeleteExportResponse:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier of the deleted export.
        exportStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Deleting
          description: The current status of the deletion. When the deletion is complete, the export will no longer be returned
            by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.
    DescribeExportRequest:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier of the export to describe.
      required:
      - exportId
    DescribeExportResponse:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier of the described export.
        resourceSpecification:
          $ref: '#/components/schemas/ExportResourceSpecification'
        fileFormat:
          type: string
          enum:
          - LexJson
          - TSV
          - CSV
          description: The file format used in the files that describe the resource.
        exportStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Deleting
          description: The status of the export. When the status is Complete the export archive file is available for download.
        failureReasons:
          type: array
          items:
            type: string
          description: If the exportStatus is failed, contains one or more reasons why the export could not be completed.
        downloadUrl:
          type: string
          description: 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:
          type: string
          format: date-time
          description: The date and time that the export was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The last date and time that the export was updated.
    ExportFilter:
      type: object
      properties:
        name:
          type: string
          enum:
          - ExportResourceType
          description: The name of the field to use for filtering.
        values:
          type: array
          items:
            type: string
          description: The values to use to filter the response. The values must be Bot, BotLocale, or CustomVocabulary.
        operator:
          type: string
          enum:
          - CO
          - EQ
          description: The operator to use for the filter. Specify EQ when the ListExports operation should return only resource
            types that equal the specified value. Specify CO when the ListExports operation should return resource types that
            contain the specified value.
      required:
      - name
      - values
      - operator
    ExportResourceSpecification:
      type: object
      properties:
        botExportSpecification:
          $ref: '#/components/schemas/BotExportSpecification'
        botLocaleExportSpecification:
          $ref: '#/components/schemas/BotLocaleExportSpecification'
        customVocabularyExportSpecification:
          $ref: '#/components/schemas/CustomVocabularyExportSpecification'
        testSetExportSpecification:
          $ref: '#/components/schemas/TestSetExportSpecification'
    ExportSortBy:
      type: object
      properties:
        attribute:
          type: string
          enum:
          - LastUpdatedDateTime
          description: The export field to use for sorting.
        order:
          type: string
          enum:
          - Ascending
          - Descending
          description: The order to sort the list.
      required:
      - attribute
      - order
    ExportSummary:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier that Amazon Lex assigned to the export.
        resourceSpecification:
          $ref: '#/components/schemas/ExportResourceSpecification'
        fileFormat:
          type: string
          enum:
          - LexJson
          - TSV
          - CSV
          description: The file format used in the export files.
        exportStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Deleting
          description: The status of the export. When the status is Completed the export is ready to download.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time that the export was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time that the export was last updated.
    GetExportRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the bot to export.
        version:
          type: string
          description: The version of the bot to export.
        resourceType:
          type: string
          enum:
          - BOT
          - INTENT
          - SLOT_TYPE
          description: The type of resource to export.
        exportType:
          type: string
          enum:
          - ALEXA_SKILLS_KIT
          - LEX
          description: The format of the exported data.
      required:
      - name
      - version
      - resourceType
      - exportType
    GetExportResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the bot being exported.
        version:
          type: string
          description: The version of the bot being exported.
        resourceType:
          type: string
          enum:
          - BOT
          - INTENT
          - SLOT_TYPE
          description: The type of the exported resource.
        exportType:
          type: string
          enum:
          - ALEXA_SKILLS_KIT
          - LEX
          description: The format of the exported data.
        exportStatus:
          type: string
          enum:
          - IN_PROGRESS
          - READY
          - FAILED
          description: 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:
          type: string
          description: If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.
        url:
          type: string
          description: 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.
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    LimitExceededException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    ListExportsRequest:
      type: object
      properties:
        botId:
          type: string
          description: The unique identifier that Amazon Lex assigned to the bot.
        botVersion:
          type: string
          description: The version of the bot to list exports for.
        sortBy:
          $ref: '#/components/schemas/ExportSortBy'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ExportFilter'
          description: Provides the specification of a filter used to limit the exports in the response to only those that
            match the filter specification. You can only specify one filter and one string to filter on.
        maxResults:
          type: integer
          description: The maximum number of exports to return in each page of results. If there are fewer results than the
            max page size, only the actual number of results are returned.
        nextToken:
          type: string
          description: If the response from the ListExports operation contains more results that specified in the maxResults
            parameter, a token is returned in the response. Use the returned token in the nextToken parameter of a ListExports
            request to return the next page of results. For a complete set of results, call the ListExports operation until
            the nextToken returned in the response is null.
        localeId:
          type: string
          description: Specifies the resources that should be exported. If you don't specify a resource type in the filters
            parameter, both bot locales and custom vocabularies are exported.
    ListExportsResponse:
      type: object
      properties:
        botId:
          type: string
          description: The unique identifier assigned to the bot by Amazon Lex.
        botVersion:
          type: string
          description: The version of the bot that was exported.
        exportSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ExportSummary'
          description: Summary information for the exports that meet the filter criteria specified in the request. The length
            of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field
            contains a token to get the next page of results.
        nextToken:
          type: string
          description: A token that indicates whether there are more results to return in a response to the ListExports operation.
            If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation
            request to get the next page of results.
        localeId:
          type: string
          description: The locale specified in the request.
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    PreconditionFailedException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
    TestSetExportSpecification:
      type: object
      properties:
        testSetId:
          type: string
          description: The unique identifier of the test set.
      required:
      - testSetId
    ThrottlingException:
      type: object
      properties:
        retryAfterSeconds:
          type: integer
          description: The number of seconds after which the user can invoke the API again.
        message:
          type: string
    UpdateExportRequest:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier Amazon Lex assigned to the export.
        filePassword:
          type: string
          description: The new password to use to encrypt the export zip archive.
      required:
      - exportId
    UpdateExportResponse:
      type: object
      properties:
        exportId:
          type: string
          description: The unique identifier Amazon Lex assigned to the export.
        resourceSpecification:
          $ref: '#/components/schemas/ExportResourceSpecification'
        fileFormat:
          type: string
          enum:
          - LexJson
          - TSV
          - CSV
          description: The file format used for the files that define the resource. The TSV format is required to export a
            custom vocabulary only; otherwise use LexJson format.
        exportStatus:
          type: string
          enum:
          - InProgress
          - Completed
          - Failed
          - Deleting
          description: The status of the export. When the status is Completed the export archive is available for download.
        creationDateTime:
          type: string
          format: date-time
          description: The date and time that the export was created.
        lastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time that the export was last updated.
    ValidationException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json