Alexa For Business
Alexa for Business API (API Version 2017-11-09)

ListSmartHomeAppliances

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

Request Syntax

{ "MaxResults": number, "NextToken": "string", "RoomArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of appliances to be returned, per paginated calls.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The tokens used for pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

RoomArn

The room that the appliances are associated with.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

Response Syntax

{ "NextToken": "string", "SmartHomeAppliances": [ { "Description": "string", "FriendlyName": "string", "ManufacturerName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The tokens used for pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

SmartHomeAppliances

The smart home appliances.

Type: Array of SmartHomeAppliance objects

Errors

For information about the errors that are common to all actions, see Common Errors.

NotFoundException

The resource is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: