Class: Aws::LexRuntimeV2::Types::PlaybackInterruptionEvent

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#caused_by_event_id ⇒ String

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

Returns:

  • (String) 


873
874
875
876
877
878
879
880
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 873

class PlaybackInterruptionEvent < Struct.new(
  :event_reason,
  :caused_by_event_id,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_id ⇒ String

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.

Returns:

  • (String) 


873
874
875
876
877
878
879
880
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 873

class PlaybackInterruptionEvent < Struct.new(
  :event_reason,
  :caused_by_event_id,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_reason ⇒ String

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

Returns:

  • (String) 


873
874
875
876
877
878
879
880
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 873

class PlaybackInterruptionEvent < Struct.new(
  :event_reason,
  :caused_by_event_id,
  :event_id,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

  • (Object) —

    the current value of event_type



873
874
875
 
# File 'gems/aws-sdk-lexruntimev2/lib/aws-sdk-lexruntimev2/types.rb', line 873

def event_type
  @event_type
end