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

#include <PostTextRequest.h>

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

Public Member Functions

 PostTextRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () 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)
 
PostTextRequestWithBotName (const Aws::String &value)
 
PostTextRequestWithBotName (Aws::String &&value)
 
PostTextRequestWithBotName (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)
 
PostTextRequestWithBotAlias (const Aws::String &value)
 
PostTextRequestWithBotAlias (Aws::String &&value)
 
PostTextRequestWithBotAlias (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)
 
PostTextRequestWithUserId (const Aws::String &value)
 
PostTextRequestWithUserId (Aws::String &&value)
 
PostTextRequestWithUserId (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)
 
PostTextRequestWithSessionAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
PostTextRequestWithSessionAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
PostTextRequestAddSessionAttributes (const Aws::String &key, const Aws::String &value)
 
PostTextRequestAddSessionAttributes (Aws::String &&key, const Aws::String &value)
 
PostTextRequestAddSessionAttributes (const Aws::String &key, Aws::String &&value)
 
PostTextRequestAddSessionAttributes (Aws::String &&key, Aws::String &&value)
 
PostTextRequestAddSessionAttributes (const char *key, Aws::String &&value)
 
PostTextRequestAddSessionAttributes (Aws::String &&key, const char *value)
 
PostTextRequestAddSessionAttributes (const char *key, const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestAttributes () const
 
bool RequestAttributesHasBeenSet () const
 
void SetRequestAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
PostTextRequestWithRequestAttributes (const Aws::Map< Aws::String, Aws::String > &value)
 
PostTextRequestWithRequestAttributes (Aws::Map< Aws::String, Aws::String > &&value)
 
PostTextRequestAddRequestAttributes (const Aws::String &key, const Aws::String &value)
 
PostTextRequestAddRequestAttributes (Aws::String &&key, const Aws::String &value)
 
PostTextRequestAddRequestAttributes (const Aws::String &key, Aws::String &&value)
 
PostTextRequestAddRequestAttributes (Aws::String &&key, Aws::String &&value)
 
PostTextRequestAddRequestAttributes (const char *key, Aws::String &&value)
 
PostTextRequestAddRequestAttributes (Aws::String &&key, const char *value)
 
PostTextRequestAddRequestAttributes (const char *key, const char *value)
 
const Aws::StringGetInputText () const
 
bool InputTextHasBeenSet () const
 
void SetInputText (const Aws::String &value)
 
void SetInputText (Aws::String &&value)
 
void SetInputText (const char *value)
 
PostTextRequestWithInputText (const Aws::String &value)
 
PostTextRequestWithInputText (Aws::String &&value)
 
PostTextRequestWithInputText (const char *value)
 
const Aws::Vector< ActiveContext > & GetActiveContexts () const
 
bool ActiveContextsHasBeenSet () const
 
void SetActiveContexts (const Aws::Vector< ActiveContext > &value)
 
void SetActiveContexts (Aws::Vector< ActiveContext > &&value)
 
PostTextRequestWithActiveContexts (const Aws::Vector< ActiveContext > &value)
 
PostTextRequestWithActiveContexts (Aws::Vector< ActiveContext > &&value)
 
PostTextRequestAddActiveContexts (const ActiveContext &value)
 
PostTextRequestAddActiveContexts (ActiveContext &&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::LexRuntimeService::LexRuntimeServiceRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file PostTextRequest.h.

Constructor & Destructor Documentation

◆ PostTextRequest()

Aws::LexRuntimeService::Model::PostTextRequest::PostTextRequest ( )

Member Function Documentation

◆ ActiveContextsHasBeenSet()

bool Aws::LexRuntimeService::Model::PostTextRequest::ActiveContextsHasBeenSet ( ) const
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 574 of file PostTextRequest.h.

◆ AddActiveContexts() [1/2]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddActiveContexts ( ActiveContext &&  value)
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 628 of file PostTextRequest.h.

◆ AddActiveContexts() [2/2]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddActiveContexts ( const ActiveContext value)
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 619 of file PostTextRequest.h.

◆ AddRequestAttributes() [1/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 484 of file PostTextRequest.h.

◆ AddRequestAttributes() [2/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( Aws::String &&  key,
const Aws::String value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 464 of file PostTextRequest.h.

◆ AddRequestAttributes() [3/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( Aws::String &&  key,
const char *  value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 504 of file PostTextRequest.h.

◆ AddRequestAttributes() [4/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( const Aws::String key,
Aws::String &&  value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 474 of file PostTextRequest.h.

◆ AddRequestAttributes() [5/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( const Aws::String key,
const Aws::String value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 454 of file PostTextRequest.h.

◆ AddRequestAttributes() [6/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( const char *  key,
Aws::String &&  value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 494 of file PostTextRequest.h.

◆ AddRequestAttributes() [7/7]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::AddRequestAttributes ( const char *  key,
const char *  value 
)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 514 of file PostTextRequest.h.

◆ AddSessionAttributes() [1/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 359 of file PostTextRequest.h.

◆ AddSessionAttributes() [2/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 343 of file PostTextRequest.h.

◆ AddSessionAttributes() [3/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 375 of file PostTextRequest.h.

◆ AddSessionAttributes() [4/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 351 of file PostTextRequest.h.

◆ AddSessionAttributes() [5/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 335 of file PostTextRequest.h.

◆ AddSessionAttributes() [6/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 367 of file PostTextRequest.h.

◆ AddSessionAttributes() [7/7]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 383 of file PostTextRequest.h.

◆ BotAliasHasBeenSet()

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

The alias of the Amazon Lex bot.

Definition at line 87 of file PostTextRequest.h.

◆ BotNameHasBeenSet()

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

The name of the Amazon Lex bot.

Definition at line 46 of file PostTextRequest.h.

◆ GetActiveContexts()

const Aws::Vector<ActiveContext>& Aws::LexRuntimeService::Model::PostTextRequest::GetActiveContexts ( ) const
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 565 of file PostTextRequest.h.

◆ GetBotAlias()

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

The alias of the Amazon Lex bot.

Definition at line 82 of file PostTextRequest.h.

◆ GetBotName()

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

The name of the Amazon Lex bot.

Definition at line 41 of file PostTextRequest.h.

◆ GetInputText()

const Aws::String& Aws::LexRuntimeService::Model::PostTextRequest::GetInputText ( ) const
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 520 of file PostTextRequest.h.

◆ GetRequestAttributes()

const Aws::Map<Aws::String, Aws::String>& Aws::LexRuntimeService::Model::PostTextRequest::GetRequestAttributes ( ) const
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 394 of file PostTextRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file PostTextRequest.h.

◆ GetSessionAttributes()

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 287 of file PostTextRequest.h.

◆ GetUserId()

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

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 138 of file PostTextRequest.h.

◆ InputTextHasBeenSet()

bool Aws::LexRuntimeService::Model::PostTextRequest::InputTextHasBeenSet ( ) const
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 525 of file PostTextRequest.h.

◆ RequestAttributesHasBeenSet()

bool Aws::LexRuntimeService::Model::PostTextRequest::RequestAttributesHasBeenSet ( ) const
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 404 of file PostTextRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SessionAttributesHasBeenSet()

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 295 of file PostTextRequest.h.

◆ SetActiveContexts() [1/2]

void Aws::LexRuntimeService::Model::PostTextRequest::SetActiveContexts ( Aws::Vector< ActiveContext > &&  value)
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 592 of file PostTextRequest.h.

◆ SetActiveContexts() [2/2]

void Aws::LexRuntimeService::Model::PostTextRequest::SetActiveContexts ( const Aws::Vector< ActiveContext > &  value)
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 583 of file PostTextRequest.h.

◆ SetBotAlias() [1/3]

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

The alias of the Amazon Lex bot.

Definition at line 97 of file PostTextRequest.h.

◆ SetBotAlias() [2/3]

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

The alias of the Amazon Lex bot.

Definition at line 92 of file PostTextRequest.h.

◆ SetBotAlias() [3/3]

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

The alias of the Amazon Lex bot.

Definition at line 102 of file PostTextRequest.h.

◆ SetBotName() [1/3]

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

The name of the Amazon Lex bot.

Definition at line 56 of file PostTextRequest.h.

◆ SetBotName() [2/3]

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

The name of the Amazon Lex bot.

Definition at line 51 of file PostTextRequest.h.

◆ SetBotName() [3/3]

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

The name of the Amazon Lex bot.

Definition at line 61 of file PostTextRequest.h.

◆ SetInputText() [1/3]

void Aws::LexRuntimeService::Model::PostTextRequest::SetInputText ( Aws::String &&  value)
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 535 of file PostTextRequest.h.

◆ SetInputText() [2/3]

void Aws::LexRuntimeService::Model::PostTextRequest::SetInputText ( const Aws::String value)
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 530 of file PostTextRequest.h.

◆ SetInputText() [3/3]

void Aws::LexRuntimeService::Model::PostTextRequest::SetInputText ( const char *  value)
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 540 of file PostTextRequest.h.

◆ SetRequestAttributes() [1/2]

void Aws::LexRuntimeService::Model::PostTextRequest::SetRequestAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 424 of file PostTextRequest.h.

◆ SetRequestAttributes() [2/2]

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

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 414 of file PostTextRequest.h.

◆ SetSessionAttributes() [1/2]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 311 of file PostTextRequest.h.

◆ SetSessionAttributes() [2/2]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 303 of file PostTextRequest.h.

◆ SetUserId() [1/3]

void Aws::LexRuntimeService::Model::PostTextRequest::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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 198 of file PostTextRequest.h.

◆ SetUserId() [2/3]

void Aws::LexRuntimeService::Model::PostTextRequest::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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 178 of file PostTextRequest.h.

◆ SetUserId() [3/3]

void Aws::LexRuntimeService::Model::PostTextRequest::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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 218 of file PostTextRequest.h.

◆ UserIdHasBeenSet()

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

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 158 of file PostTextRequest.h.

◆ WithActiveContexts() [1/2]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithActiveContexts ( Aws::Vector< ActiveContext > &&  value)
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 610 of file PostTextRequest.h.

◆ WithActiveContexts() [2/2]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithActiveContexts ( const Aws::Vector< ActiveContext > &  value)
inline

A list of contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request,

If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.

Definition at line 601 of file PostTextRequest.h.

◆ WithBotAlias() [1/3]

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

The alias of the Amazon Lex bot.

Definition at line 112 of file PostTextRequest.h.

◆ WithBotAlias() [2/3]

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

The alias of the Amazon Lex bot.

Definition at line 107 of file PostTextRequest.h.

◆ WithBotAlias() [3/3]

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

The alias of the Amazon Lex bot.

Definition at line 117 of file PostTextRequest.h.

◆ WithBotName() [1/3]

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

The name of the Amazon Lex bot.

Definition at line 71 of file PostTextRequest.h.

◆ WithBotName() [2/3]

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

The name of the Amazon Lex bot.

Definition at line 66 of file PostTextRequest.h.

◆ WithBotName() [3/3]

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

The name of the Amazon Lex bot.

Definition at line 76 of file PostTextRequest.h.

◆ WithInputText() [1/3]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithInputText ( Aws::String &&  value)
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 550 of file PostTextRequest.h.

◆ WithInputText() [2/3]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithInputText ( const Aws::String value)
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 545 of file PostTextRequest.h.

◆ WithInputText() [3/3]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithInputText ( const char *  value)
inline

The text that the user entered (Amazon Lex interprets this text).

Definition at line 555 of file PostTextRequest.h.

◆ WithRequestAttributes() [1/2]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithRequestAttributes ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 444 of file PostTextRequest.h.

◆ WithRequestAttributes() [2/2]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::WithRequestAttributes ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

Definition at line 434 of file PostTextRequest.h.

◆ WithSessionAttributes() [1/2]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 327 of file PostTextRequest.h.

◆ WithSessionAttributes() [2/2]

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

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

Definition at line 319 of file PostTextRequest.h.

◆ WithUserId() [1/3]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 258 of file PostTextRequest.h.

◆ WithUserId() [2/3]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 238 of file PostTextRequest.h.

◆ WithUserId() [3/3]

PostTextRequest& Aws::LexRuntimeService::Model::PostTextRequest::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. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

Definition at line 278 of file PostTextRequest.h.


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