Class: Aws::RoboMaker::Types::ListFleetsRequest

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 ListFleetsRequest 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 name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

Returns:



3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3685

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

#max_resultsInteger

When this parameter is used, ListFleets 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 ListFleets request with the returned nextToken value. This value can be between 1 and 200. If this parameter is not used, then ListFleets returns up to 200 results and a nextToken value if applicable.

Returns:

  • (Integer)


3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3685

class ListFleetsRequest < 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 ListFleets 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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

  • (String)


3685
3686
3687
3688
3689
3690
3691
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3685

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