SSMIncidents / Paginator / ListRelatedItems


class SSMIncidents.Paginator.ListRelatedItems#
paginator = client.get_paginator('list_related_items')

Creates an iterator that will paginate through responses from SSMIncidents.Client.list_related_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • incidentRecordArn (string) –


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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'relatedItems': [
            'generatedId': 'string',
            'identifier': {
                'value': {
                    'arn': 'string',
                    'metricDefinition': 'string',
                    'pagerDutyIncidentDetail': {
                        'autoResolve': True|False,
                        'id': 'string',
                        'secretId': 'string'
                    'url': 'string'
            'title': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • 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.


          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.


            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.

    • NextToken (string) –

      A token to resume pagination.