You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::GameLift::Types::ListFleetsInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::ListFleetsInput
- Defined in:
- (unknown)
Overview
When passing ListFleetsInput as input to an Aws::Client method, you can use a vanilla Hash:
{
build_id: "BuildIdOrArn",
script_id: "ScriptIdOrArn",
limit: 1,
next_token: "NonZeroAndMaxString",
}
Represents the input for a request operation.
Instance Attribute Summary collapse
-
#build_id ⇒ String
A unique identifier for a build to return fleets for.
-
#limit ⇒ Integer
The maximum number of results to return.
-
#next_token ⇒ String
Token that indicates the start of the next sequential page of results.
-
#script_id ⇒ String
A unique identifier for a Realtime script to return fleets for.
Instance Attribute Details
#build_id ⇒ String
A unique identifier for a build to return fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value. To retrieve all fleets, do not include either a BuildId and ScriptID parameter.
#limit ⇒ Integer
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
#next_token ⇒ String
Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
#script_id ⇒ String
A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value. To retrieve all fleets, leave this parameter empty.