---
title: "POST /updateRelatedItems"
method: POST
path: "/updateRelatedItems"
---

# POST /updateRelatedItems

`POST /updateRelatedItems`

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

## Request body

- object
  - `clientToken` string — A token that ensures that a client calls the operation only once with the specified details.
  - `incidentRecordArn` string, required — The Amazon Resource Name (ARN) of the incident record that contains the related items that you update.
  - `relatedItemsUpdate` object, required — Details about the related item you're adding.
    - `itemToAdd` object — Details about the related item you're adding.
      - `generatedId` string — <p>A unique ID for a <code>RelatedItem</code>.</p> <important> <p>Don't specify this parameter when you add a <code>RelatedItem</code> by using the <a>UpdateRelatedItems</a> API action.</p> </important>
      - `identifier` object, required — Details about the related item.
        - `type` 'ANALYSIS' | 'INCIDENT' | 'METRIC' | 'PARENT' | 'ATTACHMENT' | 'OTHER' | 'AUTOMATION' | 'INVOLVED_RESOURCE' | 'TASK', required — The type of related item.
        - `value` object, required — Details about the related item.
          - `arn` string — The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
          - `metricDefinition` string — The metric definition, if the related item is a metric in Amazon CloudWatch.
          - `pagerDutyIncidentDetail` object — Details about an incident that is associated with a PagerDuty incident.
            - `autoResolve` boolean — Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.
            - `id` string, required — The ID of the incident associated with the PagerDuty service for the response plan.
            - `secretId` string — The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
          - `url` string — The URL, if the related item is a non-Amazon Web Services resource.
      - `title` string — The title of the related item.
    - `itemToRemove` object — Details about the related item you're deleting.
      - `type` 'ANALYSIS' | 'INCIDENT' | 'METRIC' | 'PARENT' | 'ATTACHMENT' | 'OTHER' | 'AUTOMATION' | 'INVOLVED_RESOURCE' | 'TASK', required — The type of related item.
      - `value` object, required — Details about the related item.
        - `arn` string — The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
        - `metricDefinition` string — The metric definition, if the related item is a metric in Amazon CloudWatch.
        - `pagerDutyIncidentDetail` object — Details about an incident that is associated with a PagerDuty incident.
          - `autoResolve` boolean — Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.
          - `id` string, required — The ID of the incident associated with the PagerDuty service for the response plan.
          - `secretId` string — The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
        - `url` string — The URL, if the related item is a non-Amazon Web Services resource.

## Response `204`

Success

- UpdateRelatedItemsOutput

## Other responses

- `480` — ThrottlingException
- `481` — ResourceNotFoundException
- `482` — AccessDeniedException
- `483` — ValidationException
- `484` — ConflictException
- `485` — InternalServerException

---

[API](https://skmtc.net/aws/apis/ssm-incidents.md) · [All operations](https://skmtc.net/aws/apis/ssm-incidents/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/ssm-incidents/versions/18d598f1fa32/schema)