Skip to main content

content_summaries

Creates, updates, deletes, gets or lists a content_summaries resource.

Overview

Namecontent_summaries
TypeResource
Idaws.wisdom.content_summaries

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe name of the content. (pattern: <code>^[a-zA-Z0-9\s_.,-]+</code>)
content_arnstringThe Amazon Resource Name (ARN) of the content. (pattern: <code>^arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$</code>)
content_idstringThe identifier of the content. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
content_typestringThe media type of the content. (pattern: <code>^(text/(plain|html|csv))|(application/(pdf|vnd.openxmlformats-officedocument.wordprocessingml.document))|(application/x.wisdom-json;source=(salesforce|servicenow|zendesk))$</code>)
knowledge_base_arnstringThe Amazon Resource Name (ARN) of the knowledge base. (pattern: <code>^arn:[a-z-]?:wisdom:[a-z0-9-]?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$</code>)
knowledge_base_idstringThe identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it. (pattern: <code>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</code>)
metadataobjectA 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.
revision_idstringThe identifier of the revision of the content.
statusstringThe status of the content. (CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED, UPDATE_FAILED)
tagsobjectThe tags used to organize, track, or control access for this resource.
title_stringThe title of the content.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_content_summaryselectcontent_id, knowledge_base_id, regionRetrieves summary information about the content.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
content_idstringThe identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledge_base_idstringThe 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.
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves summary information about the content.

SELECT
name,
content_arn,
content_id,
content_type,
knowledge_base_arn,
knowledge_base_id,
metadata,
revision_id,
status,
tags,
title_
FROM aws.wisdom.content_summaries
WHERE content_id = '{{ content_id }}' -- required
AND knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
;