You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::RoboMaker::Types::ListRobotsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RoboMaker::Types::ListRobotsRequest
- Defined in:
- (unknown)
Overview
When passing ListRobotsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
next_token: "PaginationToken",
max_results: 1,
filters: [
{
name: "Name",
values: ["Name"],
},
],
}
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::Filter>
Optional filters to limit results.
-
#max_results ⇒ Integer
When this parameter is used,
ListRobots
only returnsmaxResults
results in a single page along with anextToken
response element. -
#next_token ⇒ String
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.
Instance Attribute Details
#filters ⇒ Array<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
.
#max_results ⇒ Integer
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.
#next_token ⇒ String
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.