Skip to content

List Exports

lexmodelsv2_list_exports R Documentation

Lists the exports for a bot, bot locale, or custom vocabulary

Description

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Usage

lexmodelsv2_list_exports(botId, botVersion, sortBy, filters, maxResults,
  nextToken, localeId)

Arguments

botId

The unique identifier that Amazon Lex assigned to the bot.

botVersion

The version of the bot to list exports for.

sortBy

Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

filters

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

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

If the response from the list_exports 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 list_exports request to return the next page of results. For a complete set of results, call the list_exports operation until the nextToken returned in the response is null.

localeId

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.

Value

A list with the following syntax: 

list(
  botId = "string",
  botVersion = "string",
  exportSummaries = list(
    list(
      exportId = "string",
      resourceSpecification = list(
        botExportSpecification = list(
          botId = "string",
          botVersion = "string"
        ),
        botLocaleExportSpecification = list(
          botId = "string",
          botVersion = "string",
          localeId = "string"
        ),
        customVocabularyExportSpecification = list(
          botId = "string",
          botVersion = "string",
          localeId = "string"
        ),
        testSetExportSpecification = list(
          testSetId = "string"
        )
      ),
      fileFormat = "LexJson"|"TSV"|"CSV",
      exportStatus = "InProgress"|"Completed"|"Failed"|"Deleting",
      creationDateTime = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string",
  localeId = "string"
)

Request syntax

svc$list_exports(
  botId = "string",
  botVersion = "string",
  sortBy = list(
    attribute = "LastUpdatedDateTime",
    order = "Ascending"|"Descending"
  ),
  filters = list(
    list(
      name = "ExportResourceType",
      values = list(
        "string"
      ),
      operator = "CO"|"EQ"
    )
  ),
  maxResults = 123,
  nextToken = "string",
  localeId = "string"
)