Class: Aws::QBusiness::Types::ActionReview

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#payload ⇒ Hash<String,Types::ActionReviewPayloadField>

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

Returns:



241
242
243
244
245
246
247
248
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 241

class ActionReview < Struct.new(
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator)
  SENSITIVE = []
  include Aws::Structure
end

#payload_field_name_separator ⇒ String

A string used to retain information about the hierarchical contexts within an action review payload.

Returns:

  • (String) 


241
242
243
244
245
246
247
248
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 241

class ActionReview < Struct.new(
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_id ⇒ String

The identifier of the plugin associated with the action review.

Returns:

  • (String) 


241
242
243
244
245
246
247
248
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 241

class ActionReview < Struct.new(
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_type ⇒ String

The type of plugin.

Returns:

  • (String) 


241
242
243
244
245
246
247
248
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 241

class ActionReview < Struct.new(
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator)
  SENSITIVE = []
  include Aws::Structure
end