ops_item_related_items

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

Overview

Name	ops_item_related_items
Type	Resource
Id	aws.ssm.ops_item_related_items

Fields

The following fields are returned by SELECT queries:

list_ops_item_related_items

Name	Datatype	Description
association_id	string	The association ID.
association_type	string	The association type.
created_by	object	Information about the user or resource that created an OpsItem event.
created_time	string (date-time)	The time the related-item association was created.
last_modified_by	object	Information about the user or resource that created an OpsItem event.
last_modified_time	string (date-time)	The time the related-item association was last updated.
ops_item_id	string	The OpsItem ID. (pattern: <code>^(oi)-[0-9a-f]{12}$</code>)
resource_type	string	The resource type.
resource_uri	string	The Amazon Resource Name (ARN) of the related-item resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_ops_item_related_items	select	region		Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.
associate_ops_item_related_item	update	region, OpsItemId, AssociationType, ResourceType, ResourceUri		Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.
disassociate_ops_item_related_item	update	region, OpsItemId, AssociationId		Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.

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_ops_item_related_items

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.

SELECT
association_id,
association_type,
created_by,
created_time,
last_modified_by,
last_modified_time,
ops_item_id,
resource_type,
resource_uri
FROM aws.ssm.ops_item_related_items
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_ops_item_related_item

Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.

UPDATE aws.ssm.ops_item_related_items
SET 
OpsItemId = '{{ OpsItemId }}',
AssociationType = '{{ AssociationType }}',
ResourceType = '{{ ResourceType }}',
ResourceUri = '{{ ResourceUri }}'
WHERE 
region = '{{ region }}' --required
AND OpsItemId = '{{ OpsItemId }}' --required
AND AssociationType = '{{ AssociationType }}' --required
AND ResourceType = '{{ ResourceType }}' --required
AND ResourceUri = '{{ ResourceUri }}' --required
RETURNING
association_id;

disassociate_ops_item_related_item

Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.

UPDATE aws.ssm.ops_item_related_items
SET 
OpsItemId = '{{ OpsItemId }}',
AssociationId = '{{ AssociationId }}'
WHERE 
region = '{{ region }}' --required
AND OpsItemId = '{{ OpsItemId }}' --required
AND AssociationId = '{{ AssociationId }}' --required;