AlexaForBusiness / Paginator / ListSmartHomeAppliances

ListSmartHomeAppliances

class AlexaForBusiness.Paginator.ListSmartHomeAppliances

paginator = client.get_paginator('list_smart_home_appliances')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• RoomArn (string) –

  [REQUIRED]

  The room that the appliances are associated with.

• 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

{
    'SmartHomeAppliances': [
        {
            'FriendlyName': 'string',
            'Description': 'string',
            'ManufacturerName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • SmartHomeAppliances (list) –

    The smart home appliances.

    • (dict) –

      A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

      • FriendlyName (string) –

        The friendly name of the smart home appliance.

      • Description (string) –

        The description of the smart home appliance.

      • ManufacturerName (string) –

        The name of the manufacturer of the smart home appliance.