Class: Aws::RoboMaker::Types::ListWorldsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RoboMaker::Types::ListWorldsRequest
- Defined in:
- gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::Filter>
Optional filters to limit results.
-
#max_results ⇒ Integer
When this parameter is used,
ListWorlds
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. You can use status
.
3874 3875 3876 3877 3878 3879 3880 |
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3874 class ListWorldsRequest < Struct.new( :next_token, :max_results, :filters) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
When this parameter is used, ListWorlds
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 ListWorlds
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter is not used,
then ListWorlds
returns up to 100 results and a nextToken
value
if applicable.
3874 3875 3876 3877 3878 3879 3880 |
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3874 class ListWorldsRequest < Struct.new( :next_token, :max_results, :filters) SENSITIVE = [] include Aws::Structure end |
#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
ListWorlds
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.
3874 3875 3876 3877 3878 3879 3880 |
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3874 class ListWorldsRequest < Struct.new( :next_token, :max_results, :filters) SENSITIVE = [] include Aws::Structure end |