plugins

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

Overview

Name	plugins
Type	Resource
Id	aws.qbusiness.plugins

Fields

The following fields are returned by SELECT queries:

get_plugin

Name	Datatype	Description
application_id	string	The identifier of the application which contains the plugin. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]{35}</code>)
auth_configuration	object	Authentication configuration information for an Amazon Q Business plugin.
build_status	string	The current status of a plugin. A plugin is modified asynchronously. (READY, CREATE_IN_PROGRESS, CREATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED)
created_at	string (date-time)	The timestamp for when the plugin was created.
custom_plugin_configuration	object	Configuration information required to create a custom plugin.
display_name	string	The name of the plugin. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
plugin_arn	string	The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
plugin_id	string	The identifier of the plugin. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
server_url	string	The source URL used for plugin configuration. (pattern: <code>(https?|ftp|file):​//([^\s]*)</code>)
state	string	The current state of the plugin. (ENABLED, DISABLED)
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)
updated_at	string (date-time)	The timestamp for when the plugin was last updated.

list_plugins

Name	Datatype	Description
build_status	string	The status of the plugin. (READY, CREATE_IN_PROGRESS, CREATE_FAILED, UPDATE_IN_PROGRESS, UPDATE_FAILED, DELETE_IN_PROGRESS, DELETE_FAILED)
created_at	string (date-time)	The timestamp for when the plugin was created.
display_name	string	The name of the plugin. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
plugin_id	string	The identifier of the plugin. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
server_url	string	The plugin server URL used for configuration. (pattern: <code>(https?|ftp|file):​//([^\s]*)</code>)
state	string	The current status of the plugin. (ENABLED, DISABLED)
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)
updated_at	string (date-time)	The timestamp for when the plugin was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_plugin	select	application_id, plugin_id, region		Gets information about an existing Amazon Q Business plugin.
list_plugins	select	application_id, region	nextToken, maxResults	Lists configured Amazon Q Business plugins.
create_plugin	insert	application_id, region, displayName, type, authConfiguration		Creates an Amazon Q Business plugin.
update_plugin	update	application_id, plugin_id, region		Updates an Amazon Q Business plugin.
delete_plugin	delete	application_id, plugin_id, region		Deletes an Amazon Q Business plugin.

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
application_id	string	The identifier the application attached to the Amazon Q Business plugin.
plugin_id	string	The identifier of the plugin being deleted.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of documents to return.
nextToken	string	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.

SELECT examples

get_plugin

Gets information about an existing Amazon Q Business plugin.

SELECT
application_id,
auth_configuration,
build_status,
created_at,
custom_plugin_configuration,
display_name,
plugin_arn,
plugin_id,
server_url,
state,
type_,
updated_at
FROM aws.qbusiness.plugins
WHERE application_id = '{{ application_id }}' -- required
AND plugin_id = '{{ plugin_id }}' -- required
AND region = '{{ region }}' -- required
;

list_plugins

Lists configured Amazon Q Business plugins.

SELECT
build_status,
created_at,
display_name,
plugin_id,
server_url,
state,
type_,
updated_at
FROM aws.qbusiness.plugins
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_plugin

Creates an Amazon Q Business plugin.

INSERT INTO aws.qbusiness.plugins (
displayName,
type,
authConfiguration,
serverUrl,
customPluginConfiguration,
tags,
clientToken,
application_id,
region
)
SELECT 
'{{ displayName }}' /* required */,
'{{ type }}' /* required */,
'{{ authConfiguration }}' /* required */,
'{{ serverUrl }}',
'{{ customPluginConfiguration }}',
'{{ tags }}',
'{{ clientToken }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
build_status,
plugin_arn,
plugin_id
;

Manifest

# Description fields are for documentation purposes
- name: plugins
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the plugins resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the plugins resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['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']
  - name: authConfiguration
    description: |
      Authentication configuration information for an Amazon Q Business plugin.
    value:
      basicAuthConfiguration:
        secretArn: "{{ secretArn }}"
        roleArn: "{{ roleArn }}"
      oAuth2ClientCredentialConfiguration:
        secretArn: "{{ secretArn }}"
        roleArn: "{{ roleArn }}"
        authorizationUrl: "{{ authorizationUrl }}"
        tokenUrl: "{{ tokenUrl }}"
      noAuthConfiguration: "{{ noAuthConfiguration }}"
      idcAuthConfiguration:
        idcApplicationArn: "{{ idcApplicationArn }}"
        roleArn: "{{ roleArn }}"
  - name: serverUrl
    value: "{{ serverUrl }}"
  - name: customPluginConfiguration
    description: |
      Configuration information required to create a custom plugin.
    value:
      description: "{{ description }}"
      apiSchemaType: "{{ apiSchemaType }}"
      apiSchema:
        payload: "{{ payload }}"
        s3:
          bucket: "{{ bucket }}"
          key: "{{ key }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_plugin

Updates an Amazon Q Business plugin.

UPDATE aws.qbusiness.plugins
SET 
displayName = '{{ displayName }}',
state = '{{ state }}',
serverUrl = '{{ serverUrl }}',
customPluginConfiguration = '{{ customPluginConfiguration }}',
authConfiguration = '{{ authConfiguration }}'
WHERE 
application_id = '{{ application_id }}' --required
AND plugin_id = '{{ plugin_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_plugin

Deletes an Amazon Q Business plugin.

DELETE FROM aws.qbusiness.plugins
WHERE application_id = '{{ application_id }}' --required
AND plugin_id = '{{ plugin_id }}' --required
AND region = '{{ region }}' --required
;