SSMContacts / Client / list_page_resolutions

list_page_resolutions#

SSMContacts.Client.list_page_resolutions(**kwargs)#

Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.

See also: AWS API Documentation

Request Syntax

response = client.list_page_resolutions(
    NextToken='string',
    PageId='string'
)
Parameters:

  • NextToken (string) – A token to start the list. Use this token to get the next set of results.

  • PageId (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      The token for the next set of items to return. Use this token to get the next set of results.

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

Exceptions

  • SSMContacts.Client.exceptions.AccessDeniedException

  • SSMContacts.Client.exceptions.InternalServerException

  • SSMContacts.Client.exceptions.ResourceNotFoundException

  • SSMContacts.Client.exceptions.ThrottlingException

  • SSMContacts.Client.exceptions.ValidationException