GetPluginCommand

Suggest an Edit

Gets information about an existing Amazon Q Business plugin.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, GetPluginCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetPluginCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetPluginRequest
  applicationId: "STRING_VALUE", // required
  pluginId: "STRING_VALUE", // required
};
const command = new GetPluginCommand(input);
const response = await client.send(command);
// { // GetPluginResponse
//   applicationId: "STRING_VALUE",
//   pluginId: "STRING_VALUE",
//   displayName: "STRING_VALUE",
//   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",
//   serverUrl: "STRING_VALUE",
//   authConfiguration: { // PluginAuthConfiguration Union: only one key present
//     basicAuthConfiguration: { // BasicAuthConfiguration
//       secretArn: "STRING_VALUE", // required
//       roleArn: "STRING_VALUE", // required
//     },
//     oAuth2ClientCredentialConfiguration: { // OAuth2ClientCredentialConfiguration
//       secretArn: "STRING_VALUE", // required
//       roleArn: "STRING_VALUE", // required
//       authorizationUrl: "STRING_VALUE",
//       tokenUrl: "STRING_VALUE",
//     },
//     noAuthConfiguration: {},
//     idcAuthConfiguration: { // IdcAuthConfiguration
//       idcApplicationArn: "STRING_VALUE", // required
//       roleArn: "STRING_VALUE", // required
//     },
//   },
//   customPluginConfiguration: { // CustomPluginConfiguration
//     description: "STRING_VALUE", // required
//     apiSchemaType: "OPEN_API_V3", // required
//     apiSchema: { // APISchema Union: only one key present
//       payload: "STRING_VALUE",
//       s3: { // S3
//         bucket: "STRING_VALUE", // required
//         key: "STRING_VALUE", // required
//       },
//     },
//   },
//   buildStatus: "READY" || "CREATE_IN_PROGRESS" || "CREATE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_FAILED" || "DELETE_IN_PROGRESS" || "DELETE_FAILED",
//   pluginArn: "STRING_VALUE",
//   state: "ENABLED" || "DISABLED",
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
// };

GetPluginCommand Input

See GetPluginCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the application which contains the plugin.

pluginId
Required
string | undefined

The identifier of the plugin.

GetPluginCommand Output

See GetPluginCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applicationId
string | undefined

The identifier of the application which contains the plugin.

authConfiguration
PluginAuthConfiguration | undefined

Authentication configuration information for an Amazon Q Business plugin.

buildStatus
PluginBuildStatus | undefined

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

createdAt
Date | undefined

The timestamp for when the plugin was created.

customPluginConfiguration
CustomPluginConfiguration | undefined

Configuration information required to create a custom plugin.

displayName
string | undefined

The name of the plugin.

pluginArn
string | undefined

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

pluginId
string | undefined

The identifier of the plugin.

serverUrl
string | undefined

The source URL used for plugin configuration.

state
PluginState | undefined

The current state of the plugin.

type
PluginType | undefined

The type of the plugin.

updatedAt
Date | undefined

The timestamp for when the plugin was last updated.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.