AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Lex PutSession API operation.

Syntax

Write-LEXSession
-BotName <String>
-Accept <String>
-BotAlias <String>
-DialogAction_FulfillmentState <FulfillmentState>
-DialogAction_IntentName <String>
-DialogAction_Message <String>
-DialogAction_MessageFormat <MessageFormatType>
-RecentIntentSummaryView <IntentSummary[]>
-SessionAttribute <Hashtable>
-DialogAction_Slot <Hashtable>
-DialogAction_SlotToElicit <String>
-DialogAction_Type <DialogActionType>
-UserId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot. For more information, see Managing Sessions.

Parameters

-Accept <String>
The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
  • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
  • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
  • If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.
  • The following are the accepted values:
    • audio/mpeg
    • audio/ogg
    • audio/pcm
    • audio/* (defaults to mpeg)
    • text/plain; charset=utf-8
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BotAlias <String>
The alias in use for the bot that contains the session data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BotName <String>
The name of the bot that contains the session data.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DialogAction_FulfillmentState <FulfillmentState>
The fulfillment state of the intent. The possible values are:
  • Failed - The Lambda function associated with the intent failed to fulfill the intent.
  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DialogAction_IntentName <String>
The name of the intent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DialogAction_Message <String>
The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DialogAction_MessageFormat <MessageFormatType>
  • PlainText - The message contains plain UTF-8 text.
  • CustomPayload - The message is a custom format for the client.
  • SSML - The message contains text formatted for voice output.
  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DialogAction_Slot <Hashtable>
Map of the slots that have been gathered and their values.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDialogAction_Slots
-DialogAction_SlotToElicit <String>
The name of the slot that should be elicited from the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DialogAction_Type <DialogActionType>
The next action that the bot should take in its interaction with the user. The possible values are:
  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as "Place the order?"
  • Close - Indicates that the there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
  • Delegate - The next action is determined by Amazon Lex.
  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
  • ElicitSlot - The next action is to elicit a slot value from the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BotName parameter. The -PassThru parameter is deprecated, use -Select '^BotName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RecentIntentSummaryView <IntentSummary[]>
A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:
  • intentName
  • slot names
  • slotToElict
If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lex.Model.PutSessionResponse). Specifying the name of a property of type Amazon.Lex.Model.PutSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionAttribute <Hashtable>
Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionAttributes
-UserId <String>
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.Lex.Model.PutSessionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z