Skip to content

Lex Runtime V2  >  Structures  >  PlaybackInterruptionEvent

PlaybackInterruptionEvent

Structure Class

PlaybackInterruptionEvent dataclass

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

Attributes

caused_by_event_id class-attribute instance-attribute
caused_by_event_id: str | None = None

The identifier of the event that contained the audio, DTMF, or text that caused the interruption.

event_id class-attribute instance-attribute
event_id: str | None = None

A unique identifier of the event sent by Amazon Lex V2. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex V2 in the current session.

event_reason class-attribute instance-attribute
event_reason: PlaybackInterruptionReason | None = None

Indicates the type of user input that Amazon Lex V2 detected.