Struct ActionSummary 

#[non_exhaustive]
pub struct ActionSummary {
    pub action_identifier: Option<String>,
    pub display_name: Option<String>,
    pub instruction_example: Option<String>,
    pub description: Option<String>,
}

Summary information for an Amazon Q Business plugin action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action_identifier: Option<String>

The identifier of an Amazon Q Business plugin action.

display_name: Option<String>

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

instruction_example: Option<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

description: Option<String>

The description of an Amazon Q Business plugin action.

Implementations

impl ActionSummary

pub fn action_identifier(&self) -> Option<&str>

The identifier of an Amazon Q Business plugin action.

pub fn display_name(&self) -> Option<&str>

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

pub fn instruction_example(&self) -> Option<&str>

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

pub fn description(&self) -> Option<&str>

The description of an Amazon Q Business plugin action.

impl ActionSummary

pub fn builder() -> ActionSummaryBuilder

Creates a new builder-style object to manufacture ActionSummary.

Trait Implementations

impl Clone for ActionSummary

fn clone(&self) -> ActionSummary

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ActionSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ActionSummary

fn eq(&self, other: &ActionSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ActionSummary