Class: Aws::QBusiness::Types::ActionSummary

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

Overview

Summary information for an Amazon Q Business plugin action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_identifier ⇒ String

The identifier of an Amazon Q Business plugin action.

Returns:

  • (String) 


415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 415

class ActionSummary < Struct.new(
  :action_identifier,
  :display_name,
  :instruction_example,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of an Amazon Q Business plugin action.

Returns:

  • (String) 


415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 415

class ActionSummary < Struct.new(
  :action_identifier,
  :display_name,
  :instruction_example,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The display name assigned by Amazon Q Business to a plugin action. You can’t modify this value.

Returns:

  • (String) 


415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 415

class ActionSummary < Struct.new(
  :action_identifier,
  :display_name,
  :instruction_example,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#instruction_example ⇒ String

An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:

  • Create a Jira task

  • Create a chat assistant task to find the root cause of a specific incident

Returns:

  • (String) 


415
416
417
418
419
420
421
422
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 415

class ActionSummary < Struct.new(
  :action_identifier,
  :display_name,
  :instruction_example,
  :description)
  SENSITIVE = []
  include Aws::Structure
end