SSMContacts / Paginator / ListContacts

ListContacts

class SSMContacts.Paginator.ListContacts

paginator = client.get_paginator('list_contacts')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AliasPrefix='string',
    Type='PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AliasPrefix (string) – Used to list only contacts who’s aliases start with the specified prefix.

• Type (string) – The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

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

dict

Returns:

Response Syntax

{
    'Contacts': [
        {
            'ContactArn': 'string',
            'Alias': 'string',
            'DisplayName': 'string',
            'Type': 'PERSONAL'|'ESCALATION'|'ONCALL_SCHEDULE'
        },
    ]
}

Response Structure

• (dict) –

  • Contacts (list) –

    A list of the contacts and escalation plans in your Incident Manager account.

    • (dict) –

      A personal contact or escalation plan that Incident Manager engages during an incident.

      • ContactArn (string) –

        The Amazon Resource Name (ARN) of the contact or escalation plan.

      • Alias (string) –

        The unique and identifiable alias of the contact or escalation plan.

      • DisplayName (string) –

        The full name of the contact or escalation plan.

      • Type (string) –

        Refers to the type of contact. A single contact is type PERSONAL and an escalation plan is type ESCALATION.