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

Inherits:

Struct

• Object
• Struct
• Aws::AlexaForBusiness::Types::SearchDevicesRequest

Defined in:

gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::Filter>

  The filters to use to list a specified set of devices.

• #max_results ⇒ Integer

  The maximum number of results to include in the response.

• #next_token ⇒ String

  An optional token returned from a prior request.

• #sort_criteria ⇒ Array<Types::Sort>

  The sort order to use in listing the specified set of devices.

Instance Attribute Details

#filters ⇒ Array<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:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-alexaforbusiness/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_results ⇒ Integer

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)

# File 'gems/aws-sdk-alexaforbusiness/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_token ⇒ String

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)

# File 'gems/aws-sdk-alexaforbusiness/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_criteria ⇒ Array<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:

• (Array<Types::Sort>)

# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 3944

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