update_related_items¶

SSMIncidents.Client.update_related_items(**kwargs)¶

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

Request Syntax

response = client.update_related_items(
    clientToken='string',
    incidentRecordArn='string',
    relatedItemsUpdate={
        'itemToAdd': {
            'generatedId': 'string',
            'identifier': {
                'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK',
                'value': {
                    'arn': 'string',
                    'metricDefinition': 'string',
                    'pagerDutyIncidentDetail': {
                        'autoResolve': True|False,
                        'id': 'string',
                        'secretId': 'string'
                    },
                    'url': 'string'
                }
            },
            'title': 'string'
        },
        'itemToRemove': {
            'type': 'ANALYSIS'|'INCIDENT'|'METRIC'|'PARENT'|'ATTACHMENT'|'OTHER'|'AUTOMATION'|'INVOLVED_RESOURCE'|'TASK',
            'value': {
                'arn': 'string',
                'metricDefinition': 'string',
                'pagerDutyIncidentDetail': {
                    'autoResolve': True|False,
                    'id': 'string',
                    'secretId': 'string'
                },
                'url': 'string'
            }
        }
    }
)

Parameters

clientToken (string) --
A token ensuring that the operation is called only once with the specified details.

This field is autopopulated if not provided.
incidentRecordArn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) of the incident record containing the related items you are updating.
relatedItemsUpdate (dict) --
[REQUIRED]

Details about the item you are adding or deleting.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: itemToAdd, itemToRemove.
- itemToAdd (dict) --
  Details about the related item you're adding.
  - generatedId (string) --
    A unique ID for a RelatedItem .
    
    Warning
    
    Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.
  - identifier (dict) -- [REQUIRED]
    Details about the related item.
    - type (string) -- [REQUIRED]
      The type of related item.
    - value (dict) -- [REQUIRED]
      Details about the related item.
      
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys can be set: arn, metricDefinition, pagerDutyIncidentDetail, url.
      - 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 (dict) --
        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 (dict) --
  Details about the related item you're deleting.
  - type (string) -- [REQUIRED]
    The type of related item.
  - value (dict) -- [REQUIRED]
    Details about the related item.
    
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys can be set: arn, metricDefinition, pagerDutyIncidentDetail, url.
    - 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 (dict) --
      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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

SSMIncidents.Client.exceptions.ThrottlingException
SSMIncidents.Client.exceptions.ResourceNotFoundException
SSMIncidents.Client.exceptions.AccessDeniedException
SSMIncidents.Client.exceptions.ValidationException
SSMIncidents.Client.exceptions.ConflictException
SSMIncidents.Client.exceptions.InternalServerException

Table Of Contents

update_related_items¶