- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdatePluginCommand
Updates an Amazon Q Business plugin.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QBusinessClient, UpdatePluginCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, UpdatePluginCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // UpdatePluginRequest
applicationId: "STRING_VALUE", // required
pluginId: "STRING_VALUE", // required
displayName: "STRING_VALUE",
state: "ENABLED" || "DISABLED",
serverUrl: "STRING_VALUE",
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
},
},
},
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
},
},
};
const command = new UpdatePluginCommand(input);
const response = await client.send(command);
// {};
UpdatePluginCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
applicationId Required | string | undefined | The identifier of the application the plugin is attached to. |
pluginId Required | string | undefined | The identifier of the plugin. |
authConfiguration | PluginAuthConfiguration | undefined | The authentication configuration the plugin is using. |
customPluginConfiguration | CustomPluginConfiguration | undefined | The configuration for a custom plugin. |
displayName | string | undefined | The name of the plugin. |
serverUrl | string | undefined | The source URL used for plugin configuration. |
state | PluginState | undefined | The status of the plugin. |
UpdatePluginCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
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. |
ConflictException | client | You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources 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. |
ServiceQuotaExceededException | client | You have exceeded the set limits for your Amazon Q Business service. |
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. |