content_summaries

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

Overview

Name	content_summaries
Type	Resource
Id	aws.qconnect.content_summaries

Fields

The following fields are returned by SELECT queries:

get_content_summary

Name	Datatype	Description
name	string	The name of the content. (pattern: <code>[a-zA-Z0-9\s_.,-]+.*</code>)
content_arn	string	The 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}){0,2}</code>)
content_id	string	The 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_type	string	The 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_arn	string	The 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}){0,2}</code>)
knowledge_base_id	string	The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
metadata	object	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.
revision_id	string	The identifier of the revision of the content.
status	string	The status of the content. (CREATE_IN_PROGRESS, CREATE_FAILED, ACTIVE, DELETE_IN_PROGRESS, DELETE_FAILED, DELETED, UPDATE_FAILED)
tags	object	The tags used to organize, track, or control access for this resource.
title_	string	The title of the content.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_content_summary	select	content_id, knowledge_base_id, region		Retrieves 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.

Name	Datatype	Description
content_id	string	The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
knowledge_base_id	string	The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
region	string	AWS region (default: us-east-1)

SELECT examples

get_content_summary

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.qconnect.content_summaries
WHERE content_id = '{{ content_id }}' -- required
AND knowledge_base_id = '{{ knowledge_base_id }}' -- required
AND region = '{{ region }}' -- required
;