Class: Aws::AlexaForBusiness::Types::SearchDevicesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-alexaforbusiness/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Returns:



3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3944

class SearchDevicesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to include in the response. If more results exist than the specified ‘MaxResults` value, a token is included in the response so that the remaining results can be retrieved.

Returns:

  • (Integer)


3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3944

class SearchDevicesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by ‘MaxResults`.

Returns:

  • (String)


3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3944

class SearchDevicesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end

#sort_criteriaArray<Types::Sort>

The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Returns:



3944
3945
3946
3947
3948
3949
3950
3951
# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 3944

class SearchDevicesRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_criteria)
  SENSITIVE = []
  include Aws::Structure
end