Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

QPluginCard - Amazon Q Business

QPluginCard

A card in an Q App that integrates with a third-party plugin or service.

Contents

dependencies

Any dependencies or requirements for the plugin card.

Type: Array of strings

Required: Yes

id

The unique identifier of the plugin card.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

Required: Yes

pluginId

The unique identifier of the plugin used by the card.

Type: String

Required: Yes

pluginType

The type or category of the plugin used by the card.

Type: String

Valid Values: SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM | ASANA | ATLASSIAN_CONFLUENCE | GOOGLE_CALENDAR | JIRA_CLOUD | MICROSOFT_EXCHANGE | MICROSOFT_TEAMS | PAGERDUTY_ADVANCE | SALESFORCE_CRM | SERVICENOW_NOW_PLATFORM | SMARTSHEET | ZENDESK_SUITE

Required: Yes

prompt

The prompt or instructions displayed for the plugin card.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50000.

Required: Yes

title

The title or label of the plugin card.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: [^{}\\"<>]+

Required: Yes

type

The type of the card.

Type: String

Valid Values: text-input | q-query | file-upload | q-plugin | form-input

Required: Yes

actionIdentifier

The action identifier of the action to be performed by the plugin card.

Type: String

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

Required: No

See Also

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.