ConnectWisdomService / Client / get_content_summary

get_content_summary#

ConnectWisdomService.Client.get_content_summary(**kwargs)#

Retrieves summary information about the content.

See also: AWS API Documentation

Request Syntax

response = client.get_content_summary(
    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 if you’re storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.

Return type:

dict

Returns:

Response Syntax

{
    'contentSummary': {
        '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'
    }
}

Response Structure

  • (dict) –

    • contentSummary (dict) –

      The content summary.

      • 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 if you’re storing Wisdom Content resource to it.

      • metadata (dict) –

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, 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.

Exceptions