QConnect / Paginator / SearchContent

SearchContent

class QConnect.Paginator.SearchContent

paginator = client.get_paginator('search_content')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    searchExpression={
        'filters': [
            {
                'field': 'NAME',
                'operator': 'EQUALS',
                'value': 'string'
            },
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• knowledgeBaseId (string) –

  [REQUIRED]

  The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

• searchExpression (dict) –

  [REQUIRED]

  The search expression to filter results.

  • filters (list) – [REQUIRED]

    The search expression filters.

    • (dict) –

      A search filter.

      • field (string) – [REQUIRED]

        The field on which to filter.

      • operator (string) – [REQUIRED]

        The operator to use for comparing the field’s value with the provided value.

      • value (string) – [REQUIRED]

        The desired field value on which to filter.

• 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

{
    'contentSummaries': [
        {
            'contentArn': 'string',
            'contentId': 'string',
            'contentType': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'metadata': {
                'string': 'string'
            },
            'name': 'string',
            'revisionId': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_FAILED',
            'tags': {
                'string': 'string'
            },
            'title': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • contentSummaries (list) –

    Summary information about the content.

    • (dict) –

      Summary information about the content.

      • contentArn (string) –

        The Amazon Resource Name (ARN) of the content.

      • contentId (string) –

        The identifier of the content.

      • contentType (string) –

        The media type of the content.

      • knowledgeBaseArn (string) –

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

      • knowledgeBaseId (string) –

        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

      • metadata (dict) –

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

        • (string) –

          • (string) –

      • name (string) –

        The name of the content.

      • revisionId (string) –

        The identifier of the revision of the content.

      • status (string) –

        The status of the content.

      • tags (dict) –

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

        • (string) –

          • (string) –

      • title (string) –

        The title of the content.

  • NextToken (string) –

    A token to resume pagination.