You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::ListFleetsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass ListFleetsInput data as a hash:

{
  build_id: "BuildId",
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#build_idString

Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

Returns:

  • (String)


3833
3834
3835
3836
3837
3838
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3833

class ListFleetsInput < Struct.new(
  :build_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#limitInteger

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

  • (Integer)


3833
3834
3835
3836
3837
3838
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3833

class ListFleetsInput < Struct.new(
  :build_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#next_tokenString

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

Returns:

  • (String)


3833
3834
3835
3836
3837
3838
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3833

class ListFleetsInput < Struct.new(
  :build_id,
  :limit,
  :next_token)
  include Aws::Structure
end