ListPluginTypeMetadata
Lists metadata for all Amazon Q Business plugin types.
Request Syntax
GET /pluginTypeMetadata?maxResults=maxResults
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of plugin metadata items to return.
Valid Range: Minimum value of 1. Maximum value of 50.
- nextToken
-
If the metadata returned exceeds
maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.Length Constraints: Minimum length of 1. Maximum length of 800.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{
"category": "string",
"description": "string",
"type": "string"
}
],
"nextToken": "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.
- items
-
An array of information on plugin metadata.
Type: Array of PluginTypeMetadataSummary objects
- nextToken
-
If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 800.
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
- 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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: