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

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

Overview

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:



3439
3440
3441
3442
3443
3444
3445
# File 'lib/aws-sdk-robomaker/types.rb', line 3439

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)


3439
3440
3441
3442
3443
3444
3445
# File 'lib/aws-sdk-robomaker/types.rb', line 3439

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

#next_tokenString

If the previous paginated request did not return all of the remaining results, the response object’s ‘nextToken` parameter value is set to a token. To retrieve the next set of results, call `ListRobots` again and assign that token to the request object’s ‘nextToken` parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null.

Returns:

  • (String)


3439
3440
3441
3442
3443
3444
3445
# File 'lib/aws-sdk-robomaker/types.rb', line 3439

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