Struct ConfigurationEvent

#[non_exhaustive]
pub struct ConfigurationEvent {
    pub request_attributes: Option<HashMap<String, String>>,
    pub response_content_type: String,
    pub session_state: Option<SessionState>,
    pub welcome_messages: Option<Vec<Message>>,
    pub disable_playback: bool,
    pub event_id: Option<String>,
    pub client_timestamp_millis: i64,
}

The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.

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.

request_attributes: Option<HashMap<String, String>>

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

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

response_content_type: String

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 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

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

session_state: Option<SessionState>

The state of the user's session with Amazon Lex V2.

welcome_messages: Option<Vec<Message>>

A list of messages to send to the user.

If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

disable_playback: bool

Determines whether Amazon Lex V2 should send audio responses to the client application.

Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

event_id: Option<String>

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

client_timestamp_millis: i64

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

Implementations

impl ConfigurationEvent

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

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

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

pub fn response_content_type(&self) -> &str

The message that Amazon Lex V2 returns in the response can be either text or speech based on the responseContentType value.

• If the value is text/plain;charset=utf-8, Amazon Lex V2 returns text in the response.

• If the value begins with audio/, Amazon Lex V2 returns speech in the response. Amazon Lex V2 uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex V2 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

  • audio/* (defaults to mpeg)

  • text/plain; charset=utf-8

pub fn session_state(&self) -> Option<&SessionState>

The state of the user's session with Amazon Lex V2.

pub fn welcome_messages(&self) -> &[Message]

A list of messages to send to the user.

If you set the welcomeMessage field, you must also set the DialogAction structure's type field.

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

pub fn disable_playback(&self) -> bool

Determines whether Amazon Lex V2 should send audio responses to the client application.

Set this field to false when the client is operating in a playback mode where audio responses are played to the user. If the client isn't operating in playback mode, such as a text chat application, set this to true so that Amazon Lex V2 doesn't wait for the prompt to finish playing on the client.

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

A unique identifier that your application assigns to the event. You can use this to identify events in logs.

pub fn client_timestamp_millis(&self) -> i64

A timestamp set by the client of the date and time that the event was sent to Amazon Lex V2.

impl ConfigurationEvent

pub fn builder() -> ConfigurationEventBuilder

Creates a new builder-style object to manufacture ConfigurationEvent.

Trait Implementations

impl Clone for ConfigurationEvent

fn clone(&self) -> ConfigurationEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurationEvent

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

Formats the value using the given formatter.

impl PartialEq for ConfigurationEvent

fn eq(&self, other: &ConfigurationEvent) -> 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 ConfigurationEvent