all_related_items

Creates, updates, deletes, gets or lists an all_related_items resource.

Overview

Name	all_related_items
Type	Resource
Id	aws.connectcases.all_related_items

Fields

The following fields are returned by SELECT queries:

search_all_related_items

Name	Datatype	Description
association_time	string (date-time)	Time at which a related item was associated with a case.
case_id	string	A unique identifier of the case.
content	object	Represents the content of a particular type of related item.
performed_by	object	Represents the entity that performed the action.
related_item_id	string	Unique identifier of a related item.
tags	object	A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.
type_	string	Type of a related item. (Contact, Comment, File, Sla, ConnectCase, Custom)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search_all_related_items	select	domain_id, region		Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API. Use cases Following are common uses cases for this API: Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions. Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts. Important things to know This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID. This API searches across related items content, not case fields. Use the SearchCases API to search within case field values. Endpoints: See Amazon Connect endpoints and quotas.

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
domain_id	string	The unique identifier of the Cases domain.
region	string	AWS region (default: us-east-1)

SELECT examples

search_all_related_items

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API. Use cases Following are common uses cases for this API: Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions. Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts. Important things to know This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID. This API searches across related items content, not case fields. Use the SearchCases API to search within case field values. Endpoints: See Amazon Connect endpoints and quotas.

SELECT
association_time,
case_id,
content,
performed_by,
related_item_id,
tags,
type_
FROM aws.connectcases.all_related_items
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
;