list_smart_home_appliances

AlexaForBusiness.Client.list_smart_home_appliances(**kwargs)

Lists all of the smart home appliances associated with a room.

See also: AWS API Documentation

Request Syntax

response = client.list_smart_home_appliances(
    RoomArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• RoomArn (string) --

  [REQUIRED]

  The room that the appliances are associated with.

• MaxResults (integer) -- The maximum number of appliances to be returned, per paginated calls.
• NextToken (string) -- The tokens used for pagination.

Return type

dict

Returns

Response Syntax

{
    'SmartHomeAppliances': [
        {
            'FriendlyName': 'string',
            'Description': 'string',
            'ManufacturerName': 'string'
        },
    ],
    'NextToken': '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.

  • NextToken (string) --

    The tokens used for pagination.

Exceptions

• AlexaForBusiness.Client.exceptions.NotFoundException