Class: Aws::Panorama::Types::ListDevicesRequest

Inherits:

Struct

• Object
• Struct
• Aws::Panorama::Types::ListDevicesRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #device_aggregated_status_filter ⇒ String

  Filter based on a device's status.

• #max_results ⇒ Integer

  The maximum number of devices to return in one page of results.

• #name_filter ⇒ String

  Filter based on device's name.

• #next_token ⇒ String

  Specify the pagination token from a previous request to retrieve the next page of results.

• #sort_by ⇒ String

  The target column to be sorted on.

• #sort_order ⇒ String

  The sorting order for the returned list.

Instance Attribute Details

#device_aggregated_status_filter ⇒ String

Filter based on a device's status.

Returns:

• (String)

# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/types.rb', line 1648

class ListDevicesRequest < Struct.new(
  :device_aggregated_status_filter,
  :max_results,
  :name_filter,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of devices to return in one page of results.

Returns:

• (Integer)

# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/types.rb', line 1648

class ListDevicesRequest < Struct.new(
  :device_aggregated_status_filter,
  :max_results,
  :name_filter,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#name_filter ⇒ String

Filter based on device's name. Prefixes supported.

Returns:

• (String)

# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/types.rb', line 1648

class ListDevicesRequest < Struct.new(
  :device_aggregated_status_filter,
  :max_results,
  :name_filter,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

Specify the pagination token from a previous request to retrieve the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/types.rb', line 1648

class ListDevicesRequest < Struct.new(
  :device_aggregated_status_filter,
  :max_results,
  :name_filter,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

The target column to be sorted on. Default column sort is CREATED_TIME.

Returns:

• (String)

# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/types.rb', line 1648

class ListDevicesRequest < Struct.new(
  :device_aggregated_status_filter,
  :max_results,
  :name_filter,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Returns:

• (String)

# File 'gems/aws-sdk-panorama/lib/aws-sdk-panorama/types.rb', line 1648

class ListDevicesRequest < Struct.new(
  :device_aggregated_status_filter,
  :max_results,
  :name_filter,
  :next_token,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end