Get Session

lexruntimeservice_get_session

R Documentation

Returns session information for a specified bot, alias, and user ID

Description

Returns session information for a specified bot, alias, and user ID.

Usage

lexruntimeservice_get_session(botName, botAlias, userId,
  checkpointLabelFilter)

Arguments

botName

[required] The name of the bot that contains the session data.

botAlias

[required] The alias in use for the bot that contains the session data.

userId

[required] The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

checkpointLabelFilter

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

Value

A list with the following syntax:

list(
  recentIntentSummaryView = list(
    list(
      intentName = "string",
      checkpointLabel = "string",
      slots = list(
        "string"
      ),
      confirmationStatus = "None"|"Confirmed"|"Denied",
      dialogActionType = "ElicitIntent"|"ConfirmIntent"|"ElicitSlot"|"Close"|"Delegate",
      fulfillmentState = "Fulfilled"|"Failed"|"ReadyForFulfillment",
      slotToElicit = "string"
    )
  ),
  sessionAttributes = list(
    "string"
  ),
  sessionId = "string",
  dialogAction = list(
    type = "ElicitIntent"|"ConfirmIntent"|"ElicitSlot"|"Close"|"Delegate",
    intentName = "string",
    slots = list(
      "string"
    ),
    slotToElicit = "string",
    fulfillmentState = "Fulfilled"|"Failed"|"ReadyForFulfillment",
    message = "string",
    messageFormat = "PlainText"|"CustomPayload"|"SSML"|"Composite"
  ),
  activeContexts = list(
    list(
      name = "string",
      timeToLive = list(
        timeToLiveInSeconds = 123,
        turnsToLive = 123
      ),
      parameters = list(
        "string"
      )
    )
  )
)

Request syntax

svc$get_session(
  botName = "string",
  botAlias = "string",
  userId = "string",
  checkpointLabelFilter = "string"
)