ActionSummary - Amazon Q Business

ActionSummary

Summary information for an Amazon Q Business plugin action.

Contents

actionIdentifier

The identifier of an Amazon Q Business plugin action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

description

The description of an Amazon Q Business plugin action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

displayName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: