AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::LexRuntimeService::Model::PutSessionRequest Class Reference

#include <PutSessionRequest.h>

+ Inheritance diagram for Aws::LexRuntimeService::Model::PutSessionRequest:

Public Member Functions

 PutSessionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBotName () const
 
bool BotNameHasBeenSet () const
 
void SetBotName (const Aws::String &value)
 
void SetBotName (Aws::String &&value)
 
void SetBotName (const char *value)
 
PutSessionRequestWithBotName (const Aws::String &value)
 
PutSessionRequestWithBotName (Aws::String &&value)
 
PutSessionRequestWithBotName (const char *value)
 
const Aws::StringGetBotAlias () const
 
bool BotAliasHasBeenSet () const
 
void SetBotAlias (const Aws::String &value)
 
void SetBotAlias (Aws::String &&value)
 
void SetBotAlias (const char *value)
 
PutSessionRequestWithBotAlias (const Aws::String &value)
 
PutSessionRequestWithBotAlias (Aws::String &&value)
 
PutSessionRequestWithBotAlias (const char *value)
 
const Aws::StringGetUserId () const
 
bool UserIdHasBeenSet () const
 
void SetUserId (const Aws::String &value)
 
void SetUserId (Aws::String &&value)
 
void SetUserId (const char *value)
 
PutSessionRequestWithUserId (const Aws::String &value)
 
PutSessionRequestWithUserId (Aws::String &&value)
 
PutSessionRequestWithUserId (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetSessionAttributes () const
 
bool SessionAttributesHasBeenSet () const
 
void SetSessionAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetSessionAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
PutSessionRequestWithSessionAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
PutSessionRequestWithSessionAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
PutSessionRequestAddSessionAttributes (const Aws::String &key, const Aws::String &value)
 
PutSessionRequestAddSessionAttributes (Aws::String &&key, const Aws::String &value)
 
PutSessionRequestAddSessionAttributes (const Aws::String &key, Aws::String &&value)
 
PutSessionRequestAddSessionAttributes (Aws::String &&key, Aws::String &&value)
 
PutSessionRequestAddSessionAttributes (const char *key, Aws::String &&value)
 
PutSessionRequestAddSessionAttributes (Aws::String &&key, const char *value)
 
PutSessionRequestAddSessionAttributes (const char *key, const char *value)
 
const DialogActionGetDialogAction () const
 
bool DialogActionHasBeenSet () const
 
void SetDialogAction (const DialogAction &value)
 
void SetDialogAction (DialogAction &&value)
 
PutSessionRequestWithDialogAction (const DialogAction &value)
 
PutSessionRequestWithDialogAction (DialogAction &&value)
 
const Aws::Vector< IntentSummary > & GetRecentIntentSummaryView () const
 
bool RecentIntentSummaryViewHasBeenSet () const
 
void SetRecentIntentSummaryView (const Aws::Vector< IntentSummary > &value)
 
void SetRecentIntentSummaryView (Aws::Vector< IntentSummary > &&value)
 
PutSessionRequestWithRecentIntentSummaryView (const Aws::Vector< IntentSummary > &value)
 
PutSessionRequestWithRecentIntentSummaryView (Aws::Vector< IntentSummary > &&value)
 
PutSessionRequestAddRecentIntentSummaryView (const IntentSummary &value)
 
PutSessionRequestAddRecentIntentSummaryView (IntentSummary &&value)
 
const Aws::StringGetAccept () const
 
bool AcceptHasBeenSet () const
 
void SetAccept (const Aws::String &value)
 
void SetAccept (Aws::String &&value)
 
void SetAccept (const char *value)
 
PutSessionRequestWithAccept (const Aws::String &value)
 
PutSessionRequestWithAccept (Aws::String &&value)
 
PutSessionRequestWithAccept (const char *value)
 
- Public Member Functions inherited from Aws::LexRuntimeService::LexRuntimeServiceRequest
virtual ~LexRuntimeServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file PutSessionRequest.h.

Constructor & Destructor Documentation

◆ PutSessionRequest()

Aws::LexRuntimeService::Model::PutSessionRequest::PutSessionRequest ( )

Member Function Documentation

◆ AcceptHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::AcceptHasBeenSet ( ) const
inline

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

Definition at line 472 of file PutSessionRequest.h.

◆ AddRecentIntentSummaryView() [1/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddRecentIntentSummaryView ( const IntentSummary value)
inline

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.

Definition at line 418 of file PutSessionRequest.h.

◆ AddRecentIntentSummaryView() [2/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddRecentIntentSummaryView ( IntentSummary &&  value)
inline

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.

Definition at line 435 of file PutSessionRequest.h.

◆ AddSessionAttributes() [1/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( const Aws::String key,
const Aws::String value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 219 of file PutSessionRequest.h.

◆ AddSessionAttributes() [2/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( Aws::String &&  key,
const Aws::String value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 226 of file PutSessionRequest.h.

◆ AddSessionAttributes() [3/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( const Aws::String key,
Aws::String &&  value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 233 of file PutSessionRequest.h.

◆ AddSessionAttributes() [4/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 240 of file PutSessionRequest.h.

◆ AddSessionAttributes() [5/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( const char *  key,
Aws::String &&  value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 247 of file PutSessionRequest.h.

◆ AddSessionAttributes() [6/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( Aws::String &&  key,
const char *  value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 254 of file PutSessionRequest.h.

◆ AddSessionAttributes() [7/7]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::AddSessionAttributes ( const char *  key,
const char *  value 
)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 261 of file PutSessionRequest.h.

◆ BotAliasHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::BotAliasHasBeenSet ( ) const
inline

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

Definition at line 90 of file PutSessionRequest.h.

◆ BotNameHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::BotNameHasBeenSet ( ) const
inline

The name of the bot that contains the session data.

Definition at line 49 of file PutSessionRequest.h.

◆ DialogActionHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::DialogActionHasBeenSet ( ) const
inline

Sets the next action that the bot should take to fulfill the conversation.

Definition at line 274 of file PutSessionRequest.h.

◆ GetAccept()

const Aws::String& Aws::LexRuntimeService::Model::PutSessionRequest::GetAccept ( ) const
inline

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

Definition at line 454 of file PutSessionRequest.h.

◆ GetBotAlias()

const Aws::String& Aws::LexRuntimeService::Model::PutSessionRequest::GetBotAlias ( ) const
inline

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

Definition at line 85 of file PutSessionRequest.h.

◆ GetBotName()

const Aws::String& Aws::LexRuntimeService::Model::PutSessionRequest::GetBotName ( ) const
inline

The name of the bot that contains the session data.

Definition at line 44 of file PutSessionRequest.h.

◆ GetDialogAction()

const DialogAction& Aws::LexRuntimeService::Model::PutSessionRequest::GetDialogAction ( ) const
inline

Sets the next action that the bot should take to fulfill the conversation.

Definition at line 268 of file PutSessionRequest.h.

◆ GetRecentIntentSummaryView()

const Aws::Vector<IntentSummary>& Aws::LexRuntimeService::Model::PutSessionRequest::GetRecentIntentSummaryView ( ) const
inline

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.

Definition at line 316 of file PutSessionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::LexRuntimeService::Model::PutSessionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::LexRuntimeService::Model::PutSessionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file PutSessionRequest.h.

◆ GetSessionAttributes()

const Aws::Map<Aws::String, Aws::String>& Aws::LexRuntimeService::Model::PutSessionRequest::GetSessionAttributes ( ) const
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 177 of file PutSessionRequest.h.

◆ GetUserId()

const Aws::String& Aws::LexRuntimeService::Model::PutSessionRequest::GetUserId ( ) const
inline

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

Definition at line 127 of file PutSessionRequest.h.

◆ RecentIntentSummaryViewHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::RecentIntentSummaryViewHasBeenSet ( ) const
inline

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.

Definition at line 333 of file PutSessionRequest.h.

◆ SerializePayload()

Aws::String Aws::LexRuntimeService::Model::PutSessionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SessionAttributesHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::SessionAttributesHasBeenSet ( ) const
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 184 of file PutSessionRequest.h.

◆ SetAccept() [1/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetAccept ( const Aws::String value)
inline

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

Definition at line 490 of file PutSessionRequest.h.

◆ SetAccept() [2/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetAccept ( Aws::String &&  value)
inline

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

Definition at line 508 of file PutSessionRequest.h.

◆ SetAccept() [3/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetAccept ( const char *  value)
inline

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

Definition at line 526 of file PutSessionRequest.h.

◆ SetBotAlias() [1/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetBotAlias ( const Aws::String value)
inline

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

Definition at line 95 of file PutSessionRequest.h.

◆ SetBotAlias() [2/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetBotAlias ( Aws::String &&  value)
inline

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

Definition at line 100 of file PutSessionRequest.h.

◆ SetBotAlias() [3/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetBotAlias ( const char *  value)
inline

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

Definition at line 105 of file PutSessionRequest.h.

◆ SetBotName() [1/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetBotName ( const Aws::String value)
inline

The name of the bot that contains the session data.

Definition at line 54 of file PutSessionRequest.h.

◆ SetBotName() [2/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetBotName ( Aws::String &&  value)
inline

The name of the bot that contains the session data.

Definition at line 59 of file PutSessionRequest.h.

◆ SetBotName() [3/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetBotName ( const char *  value)
inline

The name of the bot that contains the session data.

Definition at line 64 of file PutSessionRequest.h.

◆ SetDialogAction() [1/2]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetDialogAction ( const DialogAction value)
inline

Sets the next action that the bot should take to fulfill the conversation.

Definition at line 280 of file PutSessionRequest.h.

◆ SetDialogAction() [2/2]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetDialogAction ( DialogAction &&  value)
inline

Sets the next action that the bot should take to fulfill the conversation.

Definition at line 286 of file PutSessionRequest.h.

◆ SetRecentIntentSummaryView() [1/2]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetRecentIntentSummaryView ( const Aws::Vector< IntentSummary > &  value)
inline

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.

Definition at line 350 of file PutSessionRequest.h.

◆ SetRecentIntentSummaryView() [2/2]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetRecentIntentSummaryView ( Aws::Vector< IntentSummary > &&  value)
inline

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.

Definition at line 367 of file PutSessionRequest.h.

◆ SetSessionAttributes() [1/2]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetSessionAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 191 of file PutSessionRequest.h.

◆ SetSessionAttributes() [2/2]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetSessionAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 198 of file PutSessionRequest.h.

◆ SetUserId() [1/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetUserId ( const Aws::String value)
inline

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

Definition at line 139 of file PutSessionRequest.h.

◆ SetUserId() [2/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetUserId ( Aws::String &&  value)
inline

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

Definition at line 145 of file PutSessionRequest.h.

◆ SetUserId() [3/3]

void Aws::LexRuntimeService::Model::PutSessionRequest::SetUserId ( const char *  value)
inline

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

Definition at line 151 of file PutSessionRequest.h.

◆ UserIdHasBeenSet()

bool Aws::LexRuntimeService::Model::PutSessionRequest::UserIdHasBeenSet ( ) const
inline

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

Definition at line 133 of file PutSessionRequest.h.

◆ WithAccept() [1/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithAccept ( const Aws::String value)
inline

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

Definition at line 544 of file PutSessionRequest.h.

◆ WithAccept() [2/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithAccept ( Aws::String &&  value)
inline

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

Definition at line 562 of file PutSessionRequest.h.

◆ WithAccept() [3/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithAccept ( const char *  value)
inline

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

Definition at line 580 of file PutSessionRequest.h.

◆ WithBotAlias() [1/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithBotAlias ( const Aws::String value)
inline

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

Definition at line 110 of file PutSessionRequest.h.

◆ WithBotAlias() [2/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithBotAlias ( Aws::String &&  value)
inline

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

Definition at line 115 of file PutSessionRequest.h.

◆ WithBotAlias() [3/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithBotAlias ( const char *  value)
inline

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

Definition at line 120 of file PutSessionRequest.h.

◆ WithBotName() [1/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithBotName ( const Aws::String value)
inline

The name of the bot that contains the session data.

Definition at line 69 of file PutSessionRequest.h.

◆ WithBotName() [2/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithBotName ( Aws::String &&  value)
inline

The name of the bot that contains the session data.

Definition at line 74 of file PutSessionRequest.h.

◆ WithBotName() [3/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithBotName ( const char *  value)
inline

The name of the bot that contains the session data.

Definition at line 79 of file PutSessionRequest.h.

◆ WithDialogAction() [1/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithDialogAction ( const DialogAction value)
inline

Sets the next action that the bot should take to fulfill the conversation.

Definition at line 292 of file PutSessionRequest.h.

◆ WithDialogAction() [2/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithDialogAction ( DialogAction &&  value)
inline

Sets the next action that the bot should take to fulfill the conversation.

Definition at line 298 of file PutSessionRequest.h.

◆ WithRecentIntentSummaryView() [1/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithRecentIntentSummaryView ( const Aws::Vector< IntentSummary > &  value)
inline

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.

Definition at line 384 of file PutSessionRequest.h.

◆ WithRecentIntentSummaryView() [2/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithRecentIntentSummaryView ( Aws::Vector< IntentSummary > &&  value)
inline

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.

Definition at line 401 of file PutSessionRequest.h.

◆ WithSessionAttributes() [1/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithSessionAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 205 of file PutSessionRequest.h.

◆ WithSessionAttributes() [2/2]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithSessionAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

Definition at line 212 of file PutSessionRequest.h.

◆ WithUserId() [1/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithUserId ( const Aws::String value)
inline

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

Definition at line 157 of file PutSessionRequest.h.

◆ WithUserId() [2/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithUserId ( Aws::String &&  value)
inline

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

Definition at line 163 of file PutSessionRequest.h.

◆ WithUserId() [3/3]

PutSessionRequest& Aws::LexRuntimeService::Model::PutSessionRequest::WithUserId ( const char *  value)
inline

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

Definition at line 169 of file PutSessionRequest.h.


The documentation for this class was generated from the following file: