Class: Aws::RoboMaker::Types::ListRobotsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb

Overview

Note:

When making an API call, you may pass ListRobotsRequest data as a hash:

{
  next_token: "PaginationToken",
  max_results: 1,
  filters: [
    {
      name: "Name",
      values: ["Name"],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

Optional filters to limit results.

The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

Returns:



2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 2847

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

#max_resultsInteger

When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListRobots returns up to 200 results and a nextToken value if applicable.

Returns:

  • (Integer)


2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 2847

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

#next_tokenString

The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Returns:

  • (String)


2847
2848
2849
2850
2851
2852
2853
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 2847

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