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>
-DialogAction_SlotElicitationStyle <StyleType>
-RuntimeHints_SlotHint <Hashtable>
-Intent_Slot <Hashtable>
-DialogAction_SlotToElicit <String>
-Intent_State <IntentState>
-DialogAction_SubSlotToElicit <ElicitSubSlot>
-DialogAction_Type <DialogActionType>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonLexRuntimeV2Config>

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)
-ClientConfig <AmazonLexRuntimeV2Config>
Amazon.PowerShell.Cmdlets.LRSV2.AmazonLexRuntimeV2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DialogAction_SlotElicitationStyle <StyleType>
Configures the slot to use spell-by-letter or spell-by-word style. When you use a style on a slot, users can spell out their input to make it clear to your bot.
  • Spell by letter - "b" "o" "b"
  • Spell by word - "b as in boy" "o as in oscar" "b as in boy"
For more information, see Using spelling to enter slot values .
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_DialogAction_SlotElicitationStyle
-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_SubSlotToElicit <ElicitSubSlot>
The name of the constituent sub slot of the composite slot specified in slotToElicit that should be elicited from the user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_DialogAction_SubSlotToElicit
-DialogAction_Type <DialogActionType>
The next action that the bot should take in its interaction with the user. The following values are possible:
  • 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.
  • ElicitIntent – The next action is to elicit an intent from the user.
  • 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
-Force <SwitchParameter>
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>
Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_Intent_Slots
-Intent_State <IntentState>
Indicates the fulfillment state for the intent. The meanings of each value are as follows:
  • Failed – The bot failed to fulfill the intent.
  • Fulfilled – The bot has completed fulfillment of the intent.
  • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.
  • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.
  • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.
  • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMessages
-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:. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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)
-RuntimeHints_SlotHint <Hashtable>
A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.The first level of the slotHints map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.The intent name and slot name must exist. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_RuntimeHints_SlotHints
-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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionStateValue_ActiveContexts
-SessionStateValue_OriginatingRequestId <String>
A unique identifier for a specific request.
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
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

Amazon.LexRuntimeV2.Model.PutSessionResponse
This cmdlet returns an Amazon.LexRuntimeV2.Model.PutSessionResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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