plugin_type_metadatas

Creates, updates, deletes, gets or lists a plugin_type_metadatas resource.

Overview

Name	plugin_type_metadatas
Type	Resource
Id	aws.qbusiness.plugin_type_metadatas

Fields

The following fields are returned by SELECT queries:

list_plugin_type_metadata

Name	Datatype	Description
category	string	The category of the plugin type. (Customer relationship management (CRM), Project management, Communication, Productivity, Ticketing and incident management)
description	string	The description assigned by Amazon Q Business to a plugin. You can't modify this value.
type_	string	The type of the plugin. (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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_plugin_type_metadata	select	region	nextToken, maxResults	Lists metadata for all Amazon Q Business plugin types.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of plugin metadata items to return.
nextToken	string	If the metadata returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.

SELECT examples

list_plugin_type_metadata

Lists metadata for all Amazon Q Business plugin types.

SELECT
category,
description,
type_
FROM aws.qbusiness.plugin_type_metadatas
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;