Struct PostTextInput

#[non_exhaustive]
pub struct PostTextInput {
    pub bot_name: Option<String>,
    pub bot_alias: Option<String>,
    pub user_id: Option<String>,
    pub session_attributes: Option<HashMap<String, String>>,
    pub request_attributes: Option<HashMap<String, String>>,
    pub input_text: Option<String>,
    pub active_contexts: Option<Vec<ActiveContext>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bot_name: Option<String>

The name of the Amazon Lex bot.

bot_alias: Option<String>

The alias of the Amazon Lex bot.

user_id: Option<String>

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.

session_attributes: Option<HashMap<String, String>>

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

For more information, see Setting Session Attributes.

request_attributes: Option<HashMap<String, String>>

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.

input_text: Option<String>

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

active_contexts: Option<Vec<ActiveContext>>

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.

Implementations

impl PostTextInput

pub fn bot_name(&self) -> Option<&str>

The name of the Amazon Lex bot.

pub fn bot_alias(&self) -> Option<&str>

The alias of the Amazon Lex bot.

pub fn user_id(&self) -> Option<&str>

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.

pub fn session_attributes(&self) -> Option<&HashMap<String, String>>

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

For more information, see Setting Session Attributes.

pub fn request_attributes(&self) -> Option<&HashMap<String, String>>

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.

pub fn input_text(&self) -> Option<&str>

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

pub fn active_contexts(&self) -> &[ActiveContext]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .active_contexts.is_none().

impl PostTextInput

pub fn builder() -> PostTextInputBuilder

Creates a new builder-style object to manufacture PostTextInput.

Trait Implementations

impl Clone for PostTextInput

fn clone(&self) -> PostTextInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PostTextInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PostTextInput

fn eq(&self, other: &PostTextInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PostTextInput