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

#include <PostContentRequest.h>

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

Public Member Functions

 PostContentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
bool SignBody () 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)
 
PostContentRequestWithBotName (const Aws::String &value)
 
PostContentRequestWithBotName (Aws::String &&value)
 
PostContentRequestWithBotName (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)
 
PostContentRequestWithBotAlias (const Aws::String &value)
 
PostContentRequestWithBotAlias (Aws::String &&value)
 
PostContentRequestWithBotAlias (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)
 
PostContentRequestWithUserId (const Aws::String &value)
 
PostContentRequestWithUserId (Aws::String &&value)
 
PostContentRequestWithUserId (const char *value)
 
const Aws::StringGetSessionAttributes () const
 
bool SessionAttributesHasBeenSet () const
 
void SetSessionAttributes (const Aws::String &value)
 
void SetSessionAttributes (Aws::String &&value)
 
void SetSessionAttributes (const char *value)
 
PostContentRequestWithSessionAttributes (const Aws::String &value)
 
PostContentRequestWithSessionAttributes (Aws::String &&value)
 
PostContentRequestWithSessionAttributes (const char *value)
 
const Aws::StringGetRequestAttributes () const
 
bool RequestAttributesHasBeenSet () const
 
void SetRequestAttributes (const Aws::String &value)
 
void SetRequestAttributes (Aws::String &&value)
 
void SetRequestAttributes (const char *value)
 
PostContentRequestWithRequestAttributes (const Aws::String &value)
 
PostContentRequestWithRequestAttributes (Aws::String &&value)
 
PostContentRequestWithRequestAttributes (const char *value)
 
const Aws::StringGetAccept () const
 
bool AcceptHasBeenSet () const
 
void SetAccept (const Aws::String &value)
 
void SetAccept (Aws::String &&value)
 
void SetAccept (const char *value)
 
PostContentRequestWithAccept (const Aws::String &value)
 
PostContentRequestWithAccept (Aws::String &&value)
 
PostContentRequestWithAccept (const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- 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 IsEventStreamRequest () 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 22 of file PostContentRequest.h.

Constructor & Destructor Documentation

◆ PostContentRequest()

Aws::LexRuntimeService::Model::PostContentRequest::PostContentRequest ( )

Member Function Documentation

◆ AcceptHasBeenSet()

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 527 of file PostContentRequest.h.

◆ BotAliasHasBeenSet()

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

Alias of the Amazon Lex bot.

Definition at line 87 of file PostContentRequest.h.

◆ BotNameHasBeenSet()

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

Name of the Amazon Lex bot.

Definition at line 46 of file PostContentRequest.h.

◆ GetAccept()

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 508 of file PostContentRequest.h.

◆ GetBotAlias()

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

Alias of the Amazon Lex bot.

Definition at line 82 of file PostContentRequest.h.

◆ GetBotName()

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

Name of the Amazon Lex bot.

Definition at line 41 of file PostContentRequest.h.

◆ GetRequestAttributes()

const Aws::String& Aws::LexRuntimeService::Model::PostContentRequest::GetRequestAttributes ( ) const
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 390 of file PostContentRequest.h.

◆ GetRequestSpecificHeaders()

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

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file PostContentRequest.h.

◆ GetSessionAttributes()

const Aws::String& Aws::LexRuntimeService::Model::PostContentRequest::GetSessionAttributes ( ) const
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 291 of file PostContentRequest.h.

◆ GetUserId()

const Aws::String& Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ RequestAttributesHasBeenSet()

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

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 PostContentRequest.h.

◆ SessionAttributesHasBeenSet()

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

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 303 of file PostContentRequest.h.

◆ SetAccept() [1/3]

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 546 of file PostContentRequest.h.

◆ SetAccept() [2/3]

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 565 of file PostContentRequest.h.

◆ SetAccept() [3/3]

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 584 of file PostContentRequest.h.

◆ SetBotAlias() [1/3]

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

Alias of the Amazon Lex bot.

Definition at line 92 of file PostContentRequest.h.

◆ SetBotAlias() [2/3]

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

Alias of the Amazon Lex bot.

Definition at line 97 of file PostContentRequest.h.

◆ SetBotAlias() [3/3]

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

Alias of the Amazon Lex bot.

Definition at line 102 of file PostContentRequest.h.

◆ SetBotName() [1/3]

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

Name of the Amazon Lex bot.

Definition at line 51 of file PostContentRequest.h.

◆ SetBotName() [2/3]

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

Name of the Amazon Lex bot.

Definition at line 56 of file PostContentRequest.h.

◆ SetBotName() [3/3]

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

Name of the Amazon Lex bot.

Definition at line 61 of file PostContentRequest.h.

◆ SetRequestAttributes() [1/3]

void Aws::LexRuntimeService::Model::PostContentRequest::SetRequestAttributes ( const Aws::String value)
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 418 of file PostContentRequest.h.

◆ SetRequestAttributes() [2/3]

void Aws::LexRuntimeService::Model::PostContentRequest::SetRequestAttributes ( Aws::String &&  value)
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 432 of file PostContentRequest.h.

◆ SetRequestAttributes() [3/3]

void Aws::LexRuntimeService::Model::PostContentRequest::SetRequestAttributes ( const char *  value)
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 446 of file PostContentRequest.h.

◆ SetSessionAttributes() [1/3]

void Aws::LexRuntimeService::Model::PostContentRequest::SetSessionAttributes ( const Aws::String value)
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 315 of file PostContentRequest.h.

◆ SetSessionAttributes() [2/3]

void Aws::LexRuntimeService::Model::PostContentRequest::SetSessionAttributes ( Aws::String &&  value)
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 327 of file PostContentRequest.h.

◆ SetSessionAttributes() [3/3]

void Aws::LexRuntimeService::Model::PostContentRequest::SetSessionAttributes ( const char *  value)
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 339 of file PostContentRequest.h.

◆ SetUserId() [1/3]

void Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ SetUserId() [2/3]

void Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ SetUserId() [3/3]

void Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ SignBody()

bool Aws::LexRuntimeService::Model::PostContentRequest::SignBody ( ) const
inlineoverridevirtual

Defaults to true, if this is set to false, then signers, if they support body signing, will not do so

Reimplemented from Aws::AmazonWebServiceRequest.

Definition at line 35 of file PostContentRequest.h.

◆ UserIdHasBeenSet()

bool Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ WithAccept() [1/3]

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 603 of file PostContentRequest.h.

◆ WithAccept() [2/3]

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 622 of file PostContentRequest.h.

◆ WithAccept() [3/3]

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

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • 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 (using the configuration you specified in the Accept header). 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 returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/ * (defaults to mpeg)

Definition at line 641 of file PostContentRequest.h.

◆ WithBotAlias() [1/3]

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

Alias of the Amazon Lex bot.

Definition at line 107 of file PostContentRequest.h.

◆ WithBotAlias() [2/3]

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

Alias of the Amazon Lex bot.

Definition at line 112 of file PostContentRequest.h.

◆ WithBotAlias() [3/3]

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

Alias of the Amazon Lex bot.

Definition at line 117 of file PostContentRequest.h.

◆ WithBotName() [1/3]

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

Name of the Amazon Lex bot.

Definition at line 66 of file PostContentRequest.h.

◆ WithBotName() [2/3]

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

Name of the Amazon Lex bot.

Definition at line 71 of file PostContentRequest.h.

◆ WithBotName() [3/3]

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

Name of the Amazon Lex bot.

Definition at line 76 of file PostContentRequest.h.

◆ WithRequestAttributes() [1/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::WithRequestAttributes ( const Aws::String value)
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 460 of file PostContentRequest.h.

◆ WithRequestAttributes() [2/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::WithRequestAttributes ( Aws::String &&  value)
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 PostContentRequest.h.

◆ WithRequestAttributes() [3/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::WithRequestAttributes ( const char *  value)
inline

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

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 488 of file PostContentRequest.h.

◆ WithSessionAttributes() [1/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::WithSessionAttributes ( const Aws::String value)
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 351 of file PostContentRequest.h.

◆ WithSessionAttributes() [2/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::WithSessionAttributes ( Aws::String &&  value)
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 363 of file PostContentRequest.h.

◆ WithSessionAttributes() [3/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::WithSessionAttributes ( const char *  value)
inline

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

Definition at line 375 of file PostContentRequest.h.

◆ WithUserId() [1/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ WithUserId() [2/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.

◆ WithUserId() [3/3]

PostContentRequest& Aws::LexRuntimeService::Model::PostContentRequest::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 PostContentRequest.h.


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