QConnect / Client / list_contents

list_contents#

QConnect.Client.list_contents(**kwargs)#

Lists the content.

See also: AWS API Documentation

Request Syntax

response = client.list_contents(
    knowledgeBaseId='string',
    maxResults=123,
    nextToken='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.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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) –

      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) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • QConnect.Client.exceptions.ValidationException

  • QConnect.Client.exceptions.AccessDeniedException

  • QConnect.Client.exceptions.ResourceNotFoundException