List Slots

lexmodelsv2_list_slots

R Documentation

Gets a list of slots that match the specified criteria

Description

Gets a list of slots that match the specified criteria.

Usage

lexmodelsv2_list_slots(botId, botVersion, localeId, intentId, sortBy,
  filters, maxResults, nextToken)

Arguments

botId

[required] The identifier of the bot that contains the slot.

botVersion

[required] The version of the bot that contains the slot.

localeId

[required] The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.

intentId

[required] The unique identifier of the intent that contains the slot.

sortBy

Determines the sort order for the response from the list_slots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.

filters

Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.

maxResults

The maximum number of slots 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_slots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Value

A list with the following syntax:

list(
  botId = "string",
  botVersion = "string",
  localeId = "string",
  intentId = "string",
  slotSummaries = list(
    list(
      slotId = "string",
      slotName = "string",
      description = "string",
      slotConstraint = "Required"|"Optional",
      slotTypeId = "string",
      valueElicitationPromptSpecification = list(
        messageGroups = list(
          list(
            message = list(
              plainTextMessage = list(
                value = "string"
              ),
              customPayload = list(
                value = "string"
              ),
              ssmlMessage = list(
                value = "string"
              ),
              imageResponseCard = list(
                title = "string",
                subtitle = "string",
                imageUrl = "string",
                buttons = list(
                  list(
                    text = "string",
                    value = "string"
                  )
                )
              )
            ),
            variations = list(
              list(
                plainTextMessage = list(
                  value = "string"
                ),
                customPayload = list(
                  value = "string"
                ),
                ssmlMessage = list(
                  value = "string"
                ),
                imageResponseCard = list(
                  title = "string",
                  subtitle = "string",
                  imageUrl = "string",
                  buttons = list(
                    list(
                      text = "string",
                      value = "string"
                    )
                  )
                )
              )
            )
          )
        ),
        maxRetries = 123,
        allowInterrupt = TRUE|FALSE,
        messageSelectionStrategy = "Random"|"Ordered",
        promptAttemptsSpecification = list(
          list(
            allowInterrupt = TRUE|FALSE,
            allowedInputTypes = list(
              allowAudioInput = TRUE|FALSE,
              allowDTMFInput = TRUE|FALSE
            ),
            audioAndDTMFInputSpecification = list(
              startTimeoutMs = 123,
              audioSpecification = list(
                maxLengthMs = 123,
                endTimeoutMs = 123
              ),
              dtmfSpecification = list(
                maxLength = 123,
                endTimeoutMs = 123,
                deletionCharacter = "string",
                endCharacter = "string"
              )
            ),
            textInputSpecification = list(
              startTimeoutMs = 123
            )
          )
        )
      ),
      lastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

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