---
title: "GET /applications/{applicationId}/plugins/{pluginId}"
method: GET
path: "/applications/{applicationId}/plugins/{pluginId}"
---

# GET /applications/{applicationId}/plugins/{pluginId}

`GET /applications/{applicationId}/plugins/{pluginId}`

Gets information about an existing Amazon Q Business plugin.

## Path parameters

- `applicationId` string, required
- `pluginId` string, required

## Response `200`

Success

- GetPluginResponse
  - `applicationId` string — The identifier of the application which contains the plugin.
  - `pluginId` string — The identifier of the plugin.
  - `displayName` string — 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.
  - `serverUrl` string — The source URL used for plugin configuration.
  - `authConfiguration` PluginAuthConfiguration — Authentication configuration information for an Amazon Q Business plugin.
    - `basicAuthConfiguration` object — Information about the basic authentication credentials used to configure a plugin.
      - `secretArn` string, required — The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
      - `roleArn` string, required — The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    - `oAuth2ClientCredentialConfiguration` object — Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
      - `secretArn` string, required — The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.
      - `roleArn` string, required — The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
      - `authorizationUrl` string — The redirect URL required by the OAuth 2.0 protocol for Amazon Q Business to authenticate a plugin user through a third party authentication server.
      - `tokenUrl` string — The URL required by the OAuth 2.0 protocol to exchange an end user authorization code for an access token.
    - `noAuthConfiguration` object — Information about invoking a custom plugin without any authentication.
    - `idcAuthConfiguration` object — Information about the IAM Identity Center Application used to configure authentication for a plugin.
      - `idcApplicationArn` string, required — The Amazon Resource Name (ARN) of the IAM Identity Center Application used to configure authentication.
      - `roleArn` string, required — The Amazon Resource Name (ARN) of the IAM role with permissions to perform actions on Amazon Web Services services on your behalf.
  - `customPluginConfiguration` object — Configuration information required to create a custom plugin.
    - `description` string, required — A description for your custom plugin configuration.
    - `apiSchemaType` 'OPEN_API_V3', required — The type of OpenAPI schema to use.
    - `apiSchema` object — Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
      - `payload` string, password — The JSON or YAML-formatted payload defining the OpenAPI schema for a custom plugin.
      - `s3` object — Contains details about the S3 object containing the OpenAPI schema for a custom plugin. The schema could be in either JSON or YAML format.
        - `bucket` string, required — The name of the S3 bucket that contains the file.
        - `key` string, required — The name of the file.
  - `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.
  - `pluginArn` string — 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.
  - `createdAt` string, date-time — The timestamp for when the plugin was created.
  - `updatedAt` string, date-time — The timestamp for when the plugin was last updated.

## Other responses

- `480` — InternalServerException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — ValidationException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/qbusiness.md) · [All operations](https://skmtc.net/aws/apis/qbusiness/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/qbusiness/versions/82966d6c4053/schema)