related_items

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

Overview

Name	related_items
Type	Resource
Id	aws.ssm_incidents.related_items

Fields

The following fields are returned by SELECT queries:

list_related_items

Name	Datatype	Description
generated_id	string	A unique ID for a RelatedItem. Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action. (pattern: <code>^related-item/(ANALYSIS|INCIDENT|METRIC|PARENT|ATTACHMENT|OTHER|AUTOMATION|INVOLVED_RESOURCE|TASK)/([0-9]|[A-F]){32}$</code>)
identifier	object	Details about the related item.
title_	string	The title of the related item.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_related_items	select	region		List all related items for an incident record.
update_related_items	update	region, incidentRecordArn, relatedItemsUpdate		Add or remove related items from the related items tab of an incident record.

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
region	string	AWS region (default: us-east-1)

SELECT examples

list_related_items

List all related items for an incident record.

SELECT
generated_id,
identifier,
title_
FROM aws.ssm_incidents.related_items
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_related_items

Add or remove related items from the related items tab of an incident record.

UPDATE aws.ssm_incidents.related_items
SET 
clientToken = '{{ clientToken }}',
incidentRecordArn = '{{ incidentRecordArn }}',
relatedItemsUpdate = '{{ relatedItemsUpdate }}'
WHERE 
region = '{{ region }}' --required
AND incidentRecordArn = '{{ incidentRecordArn }}' --required
AND relatedItemsUpdate = '{{ relatedItemsUpdate }}' --required;