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 Runtime V2 PutSession API operation.

Syntax

Write-LRSV2Session
-BotId <String>
-SessionStateValue_ActiveContext <ActiveContext[]>
-BotAliasId <String>
-Intent_ConfirmationState <ConfirmationState>
-LocaleId <String>
-Message <Message[]>
-Intent_Name <String>
-SessionStateValue_OriginatingRequestId <String>
-RequestAttribute <Hashtable>
-ResponseContentType <String>
-SessionStateValue_SessionAttribute <Hashtable>
-SessionId <String>
-Intent_Slot <Hashtable>
-DialogAction_SlotToElicit <String>
-Intent_State <IntentState>
-DialogAction_Type <DialogActionType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new session or modifies an existing session with an Amazon Lex V2 bot. Use this operation to enable your application to set the state of the bot.

Parameters

-BotAliasId <String>
The alias identifier of the bot that receives the session data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-BotId <String>
The identifier of the bot that receives the session data.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DialogAction_SlotToElicit <String>
The name of the slot that should be elicited from the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_DialogAction_SlotToElicit
-DialogAction_Type <DialogActionType>
The next action that the bot should take in its interaction with the user. The possible values are:
  • Close - Indicates that there will not be a response from the user. For example, the statement "Your order has been placed" does not require a response.
  • 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?"
  • Delegate - The next action is determined by Amazon Lex V2.
  • ElicitSlot - The next action is to elicit a slot value from the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_DialogAction_Type
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)
-Intent_ConfirmationState <ConfirmationState>
Contains information about whether fulfillment of the intent has been confirmed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_Intent_ConfirmationState
-Intent_Name <String>
The name of the intent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_Intent_Name
-Intent_Slot <Hashtable>
A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_Intent_Slots
-Intent_State <IntentState>
Contains fulfillment information for the intent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_Intent_State
-LocaleId <String>
The locale where the session is in use.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Message <Message[]>
A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessages
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BotId parameter. The -PassThru parameter is deprecated, use -Select '^BotId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestAttribute <Hashtable>
Request-specific information passed between Amazon Lex V2 and the client application.The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRequestAttributes
-ResponseContentType <String>
The message that Amazon Lex V2 returns in the response can be either text or speech depending on the value of this parameter.
  • If the value is text/plain; charset=utf-8, Amazon Lex V2 returns text in the response.
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.LexRuntimeV2.Model.PutSessionResponse). Specifying the name of a property of type Amazon.LexRuntimeV2.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)
-SessionId <String>
The identifier of the session that receives the session data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionStateValue_ActiveContext <ActiveContext[]>
One or more contexts that indicate to Amazon Lex V2 the context of a request. When a context is active, Amazon Lex V2 considers intents with the matching context as a trigger as the next intent in a session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_ActiveContexts
-SessionStateValue_OriginatingRequestId <String>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionStateValue_SessionAttribute <Hashtable>
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex V2 and a client application.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_SessionAttributes

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.LexRuntimeV2.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