QBusiness / Client / create_plugin

create_plugin#

QBusiness.Client.create_plugin(**kwargs)#

Creates an Amazon Q Business plugin.

See also: AWS API Documentation

Request Syntax

response = client.create_plugin(
    applicationId='string',
    authConfiguration={
        'basicAuthConfiguration': {
            'roleArn': 'string',
            'secretArn': 'string'
        },
        'oAuth2ClientCredentialConfiguration': {
            'roleArn': 'string',
            'secretArn': 'string'
        }
    },
    clientToken='string',
    displayName='string',
    serverUrl='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    type='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the application that will contain the plugin.

  • authConfiguration (dict) –

    [REQUIRED]

    Authentication configuration information for an Amazon Q Business plugin.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: basicAuthConfiguration, oAuth2ClientCredentialConfiguration.

    • basicAuthConfiguration (dict) –

      Information about the basic authentication credentials used to configure a plugin.

      • roleArn (string) – [REQUIRED]

        The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

      • secretArn (string) – [REQUIRED]

        The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

    • oAuth2ClientCredentialConfiguration (dict) –

      Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

      • roleArn (string) – [REQUIRED]

        The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

      • secretArn (string) – [REQUIRED]

        The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • displayName (string) –

    [REQUIRED]

    A the name for your plugin.

  • serverUrl (string) –

    [REQUIRED]

    The source URL used for plugin configuration.

  • tags (list) –

    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: _ . : / = + - @.

    • (dict) –

      A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

      • key (string) – [REQUIRED]

        The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

      • value (string) – [REQUIRED]

        The value associated with the tag. The value may be an empty string but it can’t be null.

  • type (string) –

    [REQUIRED]

    The type of plugin you want to create.

Return type:

dict

Returns:

Response Syntax

{
    'pluginArn': 'string',
    'pluginId': 'string'
}

Response Structure

  • (dict) –

    • pluginArn (string) –

      The Amazon Resource Name (ARN) of a plugin.

    • pluginId (string) –

      The identifier of the plugin created.

Exceptions