Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Creates an Amazon Q Business plugin.

post/applications/{applicationId}/plugins

Path parameters

applicationIdstring required

The identifier of the application that will contain the plugin.

Request body

displayNamestring required

A the name for your plugin.

type'SERVICE_NOW' | 'SALESFORCE' | 'JIRA' | 'ZENDESK' | 'CUSTOM' | 'QUICKSIGHT' | 'SERVICENOW_NOW_PLATFORM' | 'JIRA_CLOUD' | 'SALESFORCE_CRM' | 'ZENDESK_SUITE' | 'ATLASSIAN_CONFLUENCE' | 'GOOGLE_CALENDAR' | 'MICROSOFT_TEAMS' | 'MICROSOFT_EXCHANGE' | 'PAGERDUTY_ADVANCE' | 'SMARTSHEET' | 'ASANA' required

The type of plugin you want to create.

serverUrlstring

The source URL used for plugin configuration.

clientTokenstring

A token that you provide to identify the request to create your Amazon Q Business plugin.

Response

Success

pluginIdstring

The identifier of the plugin created.

pluginArnstring

The Amazon Resource Name (ARN) of a plugin.

buildStatus'READY' | 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'UPDATE_IN_PROGRESS' | 'UPDATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED'

The current status of a plugin. A plugin is modified asynchronously.