Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about an existing Amazon Q Business plugin.

get/applications/{applicationId}/plugins/{pluginId}

Path parameters

applicationIdstring required

The identifier of the application which contains the plugin.

pluginIdstring required

The identifier of the plugin.

Response

Success

applicationIdstring

The identifier of the application which contains the plugin.

pluginIdstring

The identifier of the plugin.

displayNamestring

The name of the 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'

The type of the plugin.

serverUrlstring

The source URL used for plugin configuration.

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.

pluginArnstring

The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

state'ENABLED' | 'DISABLED'

The current state of the plugin.

createdAtstring date-time

The timestamp for when the plugin was created.

updatedAtstring date-time

The timestamp for when the plugin was last updated.