QBusiness / Paginator / ListPluginTypeMetadata

ListPluginTypeMetadata

class QBusiness.Paginator.ListPluginTypeMetadata

paginator = client.get_paginator('list_plugin_type_metadata')

paginate(**kwargs)

Creates an iterator that will paginate through responses from QBusiness.Client.list_plugin_type_metadata().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'type': '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',
            'category': 'Customer relationship management (CRM)'|'Project management'|'Communication'|'Productivity'|'Ticketing and incident management',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    An array of information on plugin metadata.

    • (dict) –

      Summary metadata information for a Amazon Q Business plugin.

      • type (string) –

        The type of the plugin.

      • category (string) –

        The category of the plugin type.

      • description (string) –

        The description assigned by Amazon Q Business to a plugin. You can’t modify this value.

  • NextToken (string) –

    A token to resume pagination.