QConnect / Paginator / ListQuickResponses


class QConnect.Paginator.ListQuickResponses#
paginator = client.get_paginator('list_quick_responses')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • knowledgeBaseId (string) –


    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • 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

    'quickResponseSummaries': [
            'channels': [
            'contentType': 'string',
            'createdTime': datetime(2015, 1, 1),
            'description': 'string',
            'isActive': True|False,
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'lastModifiedBy': 'string',
            'lastModifiedTime': datetime(2015, 1, 1),
            'name': 'string',
            'quickResponseArn': 'string',
            'quickResponseId': 'string',
            'tags': {
                'string': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • quickResponseSummaries (list) –

      Summary information about the quick responses.

      • (dict) –

        The summary information about the quick response.

        • channels (list) –

          The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

          • (string) –

        • contentType (string) –

          The media type of the quick response content.

          • Use application/x.quickresponse;format=plain for quick response written in plain text.

          • Use application/x.quickresponse;format=markdown for quick response written in richtext.

        • createdTime (datetime) –

          The timestamp when the quick response was created.

        • description (string) –

          The description of the quick response.

        • isActive (boolean) –

          Whether the quick response is active.

        • knowledgeBaseArn (string) –

          The Amazon Resource Name (ARN) of the knowledge base.

        • knowledgeBaseId (string) –

          The identifier of the knowledge base.

        • lastModifiedBy (string) –

          The Amazon Resource Name (ARN) of the user who last updated the quick response data.

        • lastModifiedTime (datetime) –

          The timestamp when the quick response summary was last modified.

        • name (string) –

          The name of the quick response.

        • quickResponseArn (string) –

          The Amazon Resource Name (ARN) of the quick response.

        • quickResponseId (string) –

          The identifier of the quick response.

        • status (string) –

          The resource status of the quick response.

        • tags (dict) –

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

          • (string) –

            • (string) –

    • NextToken (string) –

      A token to resume pagination.