QConnect / Paginator / ListAssistants


class QConnect.Paginator.ListAssistants#
paginator = client.get_paginator('list_assistants')

Creates an iterator that will paginate through responses from QConnect.Client.list_assistants().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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:



Response Syntax

    'assistantSummaries': [
            'assistantArn': 'string',
            'assistantId': 'string',
            'capabilityConfiguration': {
                'type': 'V1'|'V2'
            'description': 'string',
            'integrationConfiguration': {
                'topicIntegrationArn': 'string'
            'name': 'string',
            'serverSideEncryptionConfiguration': {
                'kmsKeyId': 'string'
            'tags': {
                'string': 'string'
            'type': 'AGENT'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • assistantSummaries (list) –

      Information about the assistants.

      • (dict) –

        Summary information about the assistant.

        • assistantArn (string) –

          The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

        • assistantId (string) –

          The identifier of the Amazon Q in Connect assistant.

        • capabilityConfiguration (dict) –

          The configuration information for the Amazon Q in Connect assistant capability.

          • type (string) –

            The type of Amazon Q in Connect assistant capability.

        • description (string) –

          The description of the assistant.

        • integrationConfiguration (dict) –

          The configuration information for the Amazon Q in Connect assistant integration.

          • topicIntegrationArn (string) –

            The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

        • name (string) –

          The name of the assistant.

        • serverSideEncryptionConfiguration (dict) –

          The configuration information for the customer managed key used for encryption.

          This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

          For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

        • status (string) –

          The status of the assistant.

        • tags (dict) –

          The tags used to organize, track, or control access for this resource.

          • (string) –

            • (string) –

        • type (string) –

          The type of the assistant.

    • NextToken (string) –

      A token to resume pagination.