SSMContacts / Paginator / ListContactChannels


class SSMContacts.Paginator.ListContactChannels#
paginator = client.get_paginator('list_contact_channels')

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

See also: AWS API Documentation

Request Syntax

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


    The Amazon Resource Name (ARN) of the contact.

  • 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

    'ContactChannels': [
            'ContactChannelArn': 'string',
            'ContactArn': 'string',
            'Name': 'string',
            'Type': 'SMS'|'VOICE'|'EMAIL',
            'DeliveryAddress': {
                'SimpleAddress': 'string'
            'ActivationStatus': 'ACTIVATED'|'NOT_ACTIVATED'

Response Structure

  • (dict) –

    • ContactChannels (list) –

      A list of contact channels related to the specified contact.

      • (dict) –

        The method that Incident Manager uses to engage a contact.

        • ContactChannelArn (string) –

          The Amazon Resource Name (ARN) of the contact channel.

        • ContactArn (string) –

          The ARN of the contact that contains the contact channel.

        • Name (string) –

          The name of the contact channel.

        • Type (string) –

          The type of the contact channel. Incident Manager supports three contact methods:

          • SMS

          • VOICE

          • EMAIL

        • DeliveryAddress (dict) –

          The details that Incident Manager uses when trying to engage the contact channel.

          • SimpleAddress (string) –

            The format is dependent on the type of the contact channel. The following are the expected formats:

            • SMS - ‘+’ followed by the country code and phone number

            • VOICE - ‘+’ followed by the country code and phone number

            • EMAIL - any standard email format

        • ActivationStatus (string) –

          A Boolean value describing if the contact channel has been activated or not. If the contact channel isn’t activated, Incident Manager can’t engage the contact through it.