Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePlugin

Creates an Amazon Q Business plugin.

Request Syntax


POST /applications/applicationId/plugins HTTP/1.1
Content-type: application/json

{
   "authConfiguration": { ... },
   "clientToken": "string",
   "customPluginConfiguration": { 
      "apiSchema": { ... },
      "apiSchemaType": "string",
      "description": "string"
   },
   "displayName": "string",
   "serverUrl": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ],
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The identifier of the application that will contain the plugin.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

Request Body

The request accepts the following data in JSON format.

authConfiguration

Authentication configuration information for an Amazon Q Business plugin.

Type: PluginAuthConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

clientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

customPluginConfiguration

Contains configuration for a custom plugin.

Type: CustomPluginConfiguration object

Required: No

displayName

A the name for your plugin.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

serverUrl

The source URL used for plugin configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (https?|ftp|file)://([^\s]*)

Required: No

tags

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

type

The type of plugin you want to create.

Type: String

Valid Values: SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOM

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "buildStatus": "string",
   "pluginArn": "string",
   "pluginId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

buildStatus

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

Type: String

pluginArn

The Amazon Resource Name (ARN) of a plugin.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

pluginId

The identifier of the plugin created.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

ConflictException

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

HTTP Status Code: 409

InternalServerException

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.

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded the set limits for your Amazon Q Business service.

HTTP Status Code: 402

ThrottlingException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400