AlexaForBusiness / Paginator / ListConferenceProviders

ListConferenceProviders

class AlexaForBusiness.Paginator.ListConferenceProviders

paginator = client.get_paginator('list_conference_providers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_conference_providers().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'ConferenceProviders': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Type': 'CHIME'|'BLUEJEANS'|'FUZE'|'GOOGLE_HANGOUTS'|'POLYCOM'|'RINGCENTRAL'|'SKYPE_FOR_BUSINESS'|'WEBEX'|'ZOOM'|'CUSTOM',
            'IPDialIn': {
                'Endpoint': 'string',
                'CommsProtocol': 'SIP'|'SIPS'|'H323'
            },
            'PSTNDialIn': {
                'CountryCode': 'string',
                'PhoneNumber': 'string',
                'OneClickIdDelay': 'string',
                'OneClickPinDelay': 'string'
            },
            'MeetingSetting': {
                'RequirePin': 'YES'|'NO'|'OPTIONAL'
            }
        },
    ],

}

Response Structure

• (dict) –

  • ConferenceProviders (list) –

    The conference providers.

    • (dict) –

      An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

      • Arn (string) –

        The ARN of the newly created conference provider.

      • Name (string) –

        The name of the conference provider.

      • Type (string) –

        The type of conference providers.

      • IPDialIn (dict) –

        The IP endpoint and protocol for calling.

        • Endpoint (string) –

          The IP address.

        • CommsProtocol (string) –

          The protocol, including SIP, SIPS, and H323.

      • PSTNDialIn (dict) –

        The information for PSTN conferencing.

        • CountryCode (string) –

          The zip code.

        • PhoneNumber (string) –

          The phone number to call to join the conference.

        • OneClickIdDelay (string) –

          The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

        • OneClickPinDelay (string) –

          The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

      • MeetingSetting (dict) –

        The meeting settings for the conference provider.

        • RequirePin (string) –

          The values that indicate whether the pin is always required.