Interface ActionSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ActionSummary.Builder,ActionSummary>, SdkBuilder<ActionSummary.Builder,ActionSummary>, SdkPojo
Enclosing class:
ActionSummary
@Mutable @NotThreadSafe public static interface ActionSummary.Builder extends SdkPojo, CopyableBuilder<ActionSummary.Builder,ActionSummary>

  • Method Details

    • actionIdentifier

      ActionSummary.Builder actionIdentifier(String actionIdentifier)

      The identifier of an Amazon Q Business plugin action.

      Parameters:
      actionIdentifier - The identifier of an Amazon Q Business plugin action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      ActionSummary.Builder displayName(String displayName)

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

      Parameters:
      displayName - The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instructionExample

      ActionSummary.Builder instructionExample(String instructionExample)

      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

      Parameters:
      instructionExample - 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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      ActionSummary.Builder description(String description)

      The description of an Amazon Q Business plugin action.

      Parameters:
      description - The description of an Amazon Q Business plugin action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.