SSMIncidents / Client / list_related_items

list_related_items

SSMIncidents.Client.list_related_items(**kwargs)

List all related items for an incident record.

See also: AWS API Documentation

Request Syntax

response = client.list_related_items(
    incidentRecordArn='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• incidentRecordArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the incident record containing the listed related items.

• maxResults (integer) – The maximum number of related items per page.

• nextToken (string) – The pagination token for the next set of items to return. (You received this token from a previous call.)

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'relatedItems': [
        {
            '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'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

  • relatedItems (list) –

    Details about each related item.

    • (dict) –

      Resources that responders use to triage and mitigate the incident.

      • 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) –

        Details about the related item.

        • type (string) –

          The type of related item.

        • value (dict) –

          Details about the related item.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: arn, metricDefinition, pagerDutyIncidentDetail, url. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • 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) –

              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.

Exceptions

• SSMIncidents.Client.exceptions.ThrottlingException

• SSMIncidents.Client.exceptions.AccessDeniedException

• SSMIncidents.Client.exceptions.ValidationException

• SSMIncidents.Client.exceptions.InternalServerException