QConnect / Client / get_content

get_content

QConnect.Client.get_content(**kwargs)

Retrieves content, including a pre-signed URL to download the content.

See also: AWS API Documentation

Request Syntax

response = client.get_content(
    contentId='string',
    knowledgeBaseId='string'
)

Parameters:

• contentId (string) –

  [REQUIRED]

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

• 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.

Return type:

dict

Returns:

Response Syntax

{
    'content': {
        'contentArn': 'string',
        'contentId': 'string',
        'contentType': 'string',
        'knowledgeBaseArn': 'string',
        'knowledgeBaseId': 'string',
        'linkOutUri': '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',
        'url': 'string',
        'urlExpiry': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • content (dict) –

    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.

    • linkOutUri (string) –

      The URI of the content.

    • 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 content revision.

    • 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.

    • url (string) –

      The URL of the content.

    • urlExpiry (datetime) –

      The expiration time of the URL as an epoch timestamp.

Exceptions

• QConnect.Client.exceptions.ValidationException

• QConnect.Client.exceptions.AccessDeniedException

• QConnect.Client.exceptions.ResourceNotFoundException