SSMContacts / Paginator / ListPageResolutions

ListPageResolutions

class SSMContacts.Paginator.ListPageResolutions

paginator = client.get_paginator('list_page_resolutions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSMContacts.Client.list_page_resolutions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PageId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• PageId (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the contact engaged for the incident.

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

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'PageResolutions': [
        {
            'ContactArn': 'string',
            'Type': 'PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE',
            'StageIndex': 123
        },
    ]
}

Response Structure

• (dict) –

  • PageResolutions (list) –

    Information about the resolution for an engagement.

    • (dict) –

      Information about the engagement resolution steps. The resolution starts from the first contact, which can be an escalation plan, then resolves to an on-call rotation, and finally to a personal contact.

      The ResolutionContact structure describes the information for each node or step in that process. It contains information about different contact types, such as the escalation, rotation, and personal contacts.

      • ContactArn (string) –

        The Amazon Resource Name (ARN) of a contact in the engagement resolution process.

      • Type (string) –

        The type of contact for a resolution step.

      • StageIndex (integer) –

        The stage in the escalation plan that resolves to this contact.