Class: Aws::RoboMaker::Types::ListWorldsRequest

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 ListWorldsRequest 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. You can use status.

Returns:



4633
4634
4635
4636
4637
4638
4639
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4633

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

#max_resultsInteger

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.

Returns:

  • (Integer)


4633
4634
4635
4636
4637
4638
4639
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4633

class ListWorldsRequest < 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 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.

Returns:

  • (String)


4633
4634
4635
4636
4637
4638
4639
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4633

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