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

Class: Aws::GameLift::Types::DescribeFleetCapacityInput

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 DescribeFleetCapacityInput data as a hash:

{
  fleet_ids: ["FleetId"],
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idsArray<String>

Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

Returns:

  • (Array<String>)


1402
1403
1404
1405
1406
1407
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1402

class DescribeFleetCapacityInput < Struct.new(
  :fleet_ids,
  :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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Returns:

  • (Integer)


1402
1403
1404
1405
1406
1407
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1402

class DescribeFleetCapacityInput < Struct.new(
  :fleet_ids,
  :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. This parameter is ignored when the request specifies one or a list of fleet IDs.

Returns:

  • (String)


1402
1403
1404
1405
1406
1407
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 1402

class DescribeFleetCapacityInput < Struct.new(
  :fleet_ids,
  :limit,
  :next_token)
  include Aws::Structure
end