String aliasId
Unique identifier for a fleet alias.
String name
Descriptive label associated with an alias. Alias names do not need to be unique.
String description
Human-readable description of an alias.
RoutingStrategy routingStrategy
Date creationTime
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Date lastUpdatedTime
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
String buildId
Unique identifier for a build.
String name
Descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
String version
Version associated with this build. Version strings do not need to be unique to a build. This value can be set using CreateBuild or UpdateBuild.
String status
Current status of the build.
Possible build statuses include the following:
INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.
READY – The game build has been successfully uploaded. You can now create new fleets for this build.
FAILED – The game build upload failed. You cannot create new fleets for this build.
Long sizeOnDisk
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this
value is 0.
String operatingSystem
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
Date creationTime
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
String name
Descriptive label associated with an alias. Alias names do not need to be unique.
String description
Human-readable description of an alias.
RoutingStrategy routingStrategy
Object specifying the fleet and routing type to use for the alias.
Alias alias
Object containing the newly created alias record.
String name
Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed
later using UpdateBuild .
String version
Version associated with this build. Version strings do not need to be unique to a build. A build version can be
changed later using UpdateBuild .
S3Location storageLocation
String operatingSystem
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
Build build
Set of properties for the newly created build.
Credentials uploadCredentials
AWS credentials required when uploading a game build to the storage location. These credentials have a limited
lifespan and are valid only for the build they were issued for. If you need to get fresh credentials, call
RequestUploadCredentials .
S3Location storageLocation
Amazon S3 path and key, identifying where the game build files are stored.
String name
Descriptive label associated with a fleet. Fleet names do not need to be unique.
String description
Human-readable description of a fleet.
String buildId
Unique identifier of the build to be deployed on the new fleet. The build must have been successfully uploaded to
GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
String serverLaunchPath
This parameter is no longer used. Instead, specify a server launch path using the
RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters
instead of a runtime configuration will continue to work.)
String serverLaunchParameters
This parameter is no longer used. Instead, specify server launch parameters in the
RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters
instead of a runtime configuration will continue to work.)
List<E> logPaths
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs stored on each instance at C:\game\logs. Use the GameLift console to
access stored logs.
String eC2InstanceType
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
List<E> eC2InboundPermissions
Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.
String newGameSessionProtectionPolicy
Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
NoProtection – The game session can be terminated during a scale-down event.
FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a
scale-down event.
RuntimeConfiguration runtimeConfiguration
Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet
has a collection of server process configurations, one for each type of server process to run on an instance. A
server process configuration specifies the location of the server executable, launch parameters, and the number
of concurrent processes with that configuration to maintain on each instance. A CreateFleet request
must include a runtime configuration with at least one server process configuration; otherwise the request will
fail with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and
ServerLaunchParameters; requests that contain values for these parameters instead of a runtime
configuration will continue to work.)
ResourceCreationLimitPolicy resourceCreationLimitPolicy
Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
FleetAttributes fleetAttributes
Properties for the newly created fleet.
String fleetId
Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.
String aliasId
Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.
Integer maximumPlayerSessionCount
Maximum number of players that can be connected simultaneously to the game session.
String name
Descriptive label associated with a game session. Session names do not need to be unique.
List<E> gameProperties
Set of properties used to administer a game session. These properties are passed to the server process hosting it.
String creatorId
Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.
String gameSessionId
Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>". For example, this full game session ID: "arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session" includes the custom ID string "my-game-session". If this parameter is not set, GameLift creates a game session ID in the same format with an auto-generated ID string.
GameSession gameSession
Object containing the newly created game session record.
String gameSessionId
Unique identifier for the game session to add a player to. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
String playerId
Unique identifier for the player to be added.
PlayerSession playerSession
Object containing the newly created player session record.
String gameSessionId
Unique identifier for the game session to add players to. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
List<E> playerIds
List of unique identifiers for the players to be added.
String aliasId
Unique identifier for a fleet alias. Specify the alias you want to delete.
String buildId
Unique identifier for the build you want to delete.
String fleetId
Unique identifier for the fleet you want to delete.
String aliasId
Unique identifier for a fleet alias. Specify the alias you want to retrieve.
Alias alias
Object containing the requested alias.
String buildId
Unique identifier of the build that you want to retrieve properties for.
Build build
Set of properties describing the requested build.
String eC2InstanceType
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.
List<E> fleetIds
Unique identifiers for the fleet(s) that you want to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.
Integer limit
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.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
List<E> fleetAttributes
Collection of objects containing attribute metadata for each requested fleet ID.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
List<E> fleetIds
Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.
Integer limit
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.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
List<E> fleetCapacity
Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String fleetId
Unique identifier for the fleet to get event logs for.
Date startTime
Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Date endTime
Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
String fleetId
Unique identifier for the fleet you want to retrieve port settings for.
List<E> fleetIds
Unique identifier for the fleet(s) you want to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.
Integer limit
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.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
List<E> fleetUtilization
Collection of objects containing utilization information for each requested fleet ID.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String fleetId
Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
String gameSessionId
Unique identifier for the game session to retrieve information on. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
String aliasId
Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
String statusFilter
Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED,
ACTIVATING and TERMINATING (the last two are transitory).
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> gameSessionDetails
Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String fleetId
Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
String gameSessionId
Unique identifier for the game session to retrieve information on. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
String aliasId
Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
String statusFilter
Game session status to filter results on. Possible game session statuses include ACTIVE,
TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> gameSessions
Collection of objects containing game session properties for each session matching the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String fleetId
Unique identifier for a fleet. Specify the fleet to retrieve instance information for.
String instanceId
Unique identifier for an instance. Specify an instance to retrieve information for or leave blank to get information on all instances in the fleet.
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
String gameSessionId
Unique identifier for the game session to get player sessions for.Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
String playerId
Unique identifier for a player.
String playerSessionId
Unique identifier for a player session.
String playerSessionStatusFilter
Player session status to filter results on.
Possible player session statuses include the following:
RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.
ACTIVE – The player has been validated by the server process and is currently connected.
COMPLETED – The player connection has been dropped.
TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages. If a player session ID is specified, this parameter is ignored.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
List<E> playerSessions
Collection of objects containing properties for each player session that matches the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String fleetId
Unique identifier of the fleet to get the runtime configuration for.
RuntimeConfiguration runtimeConfiguration
Instructions describing how server processes should be launched and maintained on each instance in the fleet.
String fleetId
Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
String statusFilter
Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
status.
ACTIVE – The scaling policy is currently in force.
UPDATEREQUESTED – A request to update the scaling policy has been received.
UPDATING – A change is being made to the scaling policy.
DELETEREQUESTED – A request to delete the scaling policy has been received.
DELETING – The scaling policy is being deleted.
DELETED – The scaling policy has been deleted.
ERROR – An error occurred in creating the policy. It should be removed and recreated.
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
Integer dESIRED
Ideal number of active instances in the fleet.
Integer mINIMUM
Minimum value allowed for the fleet's instance count.
Integer mAXIMUM
Maximum value allowed for the fleet's instance count.
Integer pENDING
Number of instances in the fleet that are starting but not yet active.
Integer aCTIVE
Actual number of active instances in the fleet.
Integer iDLE
Number of active instances in the fleet that are not currently hosting a game session.
Integer tERMINATING
Number of instances in the fleet that are no longer active but haven't yet been terminated.
String eC2InstanceType
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
Integer currentInstances
Number of instances of the specified type that are currently in use by this AWS account.
Integer instanceLimit
Number of instances allowed.
String eventId
Unique identifier for a fleet event.
String resourceId
Unique identifier for the resource, such as a fleet ID.
String eventCode
Type of event being logged.
String message
Additional information related to the event.
Date eventTime
Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
String fleetId
Unique identifier for a fleet.
String description
Human-readable description of the fleet.
String name
Descriptive label associated with a fleet. Fleet names do not need to be unique.
Date creationTime
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Date terminationTime
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
String status
Current status of the fleet.
Possible fleet statuses include the following:
NEW – A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.
ACTIVE – Hosts can now accept game sessions.
ERROR – An error occurred when downloading, validating, building, or activating the fleet.
DELETING – Hosts are responding to a delete fleet request.
TERMINATED – The fleet no longer exists.
String buildId
Unique identifier for a build.
String serverLaunchPath
Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS
SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's
RuntimeConfiguration .
String serverLaunchParameters
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server
launch parameters for fleets created after this date are specified in the fleet's
RuntimeConfiguration .
List<E> logPaths
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will
automatically upload logs stored on each instance at C:\game\logs. Use the GameLift console to
access stored logs.
String newGameSessionProtectionPolicy
Type of game session protection to set for all new instances started in the fleet.
NoProtection – The game session can be terminated during a scale-down event.
FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a
scale-down event.
String operatingSystem
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
ResourceCreationLimitPolicy resourceCreationLimitPolicy
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
String fleetId
Unique identifier for a fleet.
String instanceType
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
EC2InstanceCounts instanceCounts
Current status of fleet capacity.
String fleetId
Unique identifier for a fleet.
Integer activeServerProcessCount
Number of server processes in an ACTIVE status currently running across all instances in the fleet
Integer activeGameSessionCount
Number of active game sessions currently being hosted on all instances in the fleet.
Integer currentPlayerSessionCount
Number of active player sessions currently being hosted on all instances in the fleet.
Integer maximumPlayerSessionCount
Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.
String gameSessionId
Unique identifier for a game session. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
String name
Descriptive label associated with a game session. Session names do not need to be unique.
String fleetId
Unique identifier for a fleet.
Date creationTime
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Date terminationTime
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Integer currentPlayerSessionCount
Number of players currently in the game session.
Integer maximumPlayerSessionCount
Maximum number of players allowed in the game session.
String status
Current status of the game session. A game session must be in an ACTIVE status to have player
sessions.
List<E> gameProperties
Set of custom properties for the game session.
String ipAddress
IP address of the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
Integer port
Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
String playerSessionCreationPolicy
Indicates whether or not the game session is accepting new players.
String creatorId
Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.
GameSession gameSession
String protectionPolicy
Current status of protection for the game session.
NoProtection – The game session can be terminated during a scale-down event.
FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a
scale-down event.
String gameSessionId
Unique identifier for the game session to get logs for. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
String preSignedUrl
Location of the requested game session logs, available for download.
String fleetId
Unique identifier for the fleet that the instance belongs to.
String instanceId
Unique identifier for the instance.
String ipAddress
IP address assigned to the instance.
String operatingSystem
Operating system being used on this instance.
String type
EC2 instance type that defines the computing resources of this instance.
String status
Current status of the instance. Possible statuses include the following:
PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's runtime configuration.
ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
Date creationTime
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057").
Integer fromPort
Starting value for a range of allowed port numbers.
Integer toPort
Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than
FromPort.
String ipRange
Range of allowed IP addresses. This value must be expressed in CIDR
notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "
0.0.0.0/[subnet mask]".
String protocol
Network communication protocol used by the fleet.
String routingStrategyType
Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
String name
Descriptive label associated with an alias. Alias names do not need to be unique.
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
String status
Build status to filter results by. To retrieve all builds, leave this parameter empty.
Possible build statuses include the following:
INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.
READY – The game build has been successfully uploaded. You can now create new fleets for this build.
FAILED – The game build upload failed. You cannot create new fleets for this build.
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
String buildId
Unique identifier of the build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> fleetIds
Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, and DescribeFleetUtilization.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String playerSessionId
Unique identifier for a player session.
String playerId
Unique identifier for a player.
String gameSessionId
Unique identifier for the game session that the player session is connected to.
String fleetId
Unique identifier for a fleet.
Date creationTime
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
Date terminationTime
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: "1469498468.057".
String status
Current status of the player session.
Possible player session statuses include the following:
RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.
ACTIVE – The player has been validated by the server process and is currently connected.
COMPLETED – The player connection has been dropped.
TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).
String ipAddress
Game session IP address. All player sessions reference the game session location.
Integer port
Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
String name
Descriptive label associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
String fleetId
Unique identity for the fleet to scale with this policy.
Integer scalingAdjustment
Amount of adjustment to make, based on the scaling adjustment type.
String scalingAdjustmentType
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity – set the instance count to the scaling adjustment value.
PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales the fleet down by 10%.
Double threshold
Metric value used to trigger a scaling event.
String comparisonOperator
Comparison operator to use when measuring the metric against the threshold value.
Integer evaluationPeriods
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String metricName
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions – number of game sessions in the process of being created (game session status =
ACTIVATING).
ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE
).
CurrentPlayerSessions – number of active or reserved player sessions (player session status =
ACTIVE or RESERVED).
AvailablePlayerSessions – number of player session slots currently available in active game sessions
across the fleet, calculated by subtracting a game session's current player session count from its maximum player
session count. This number includes game sessions that are not currently accepting players (game session
PlayerSessionCreationPolicy = DENY_ALL).
ActiveInstances – number of instances currently running a game session.
IdleInstances – number of instances not currently running a game session.
String name
Descriptive label associated with a scaling policy. Policy names do not need to be unique.
String buildId
Unique identifier for the build you want to get credentials for.
Credentials uploadCredentials
AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.
S3Location storageLocation
Amazon S3 path and key, identifying where the game build files are stored.
String aliasId
Unique identifier for the alias you want to resolve.
String fleetId
Fleet ID associated with the requested alias.
String type
Type of routing strategy.
Possible routing types include the following:
SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
String fleetId
Unique identifier for a fleet.
String message
Message text to be used with a terminal routing strategy.
String fleetId
Unique identity for the fleet associated with this scaling policy.
String name
Descriptive label associated with a scaling policy. Policy names do not need to be unique.
String status
Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE status.
ACTIVE – The scaling policy is currently in force.
UPDATE_REQUESTED – A request to update the scaling policy has been received.
UPDATING – A change is being made to the scaling policy.
DELETE_REQUESTED – A request to delete the scaling policy has been received.
DELETING – The scaling policy is being deleted.
DELETED – The scaling policy has been deleted.
ERROR – An error occurred in creating the policy. It should be removed and recreated.
Integer scalingAdjustment
Amount of adjustment to make, based on the scaling adjustment type.
String scalingAdjustmentType
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity – set the instance count to the scaling adjustment value.
PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
String comparisonOperator
Comparison operator to use when measuring a metric against the threshold value.
Double threshold
Metric value used to trigger a scaling event.
Integer evaluationPeriods
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String metricName
Name of the GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions – number of game sessions in the process of being created (game session status =
ACTIVATING).
ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE
).
CurrentPlayerSessions – number of active or reserved player sessions (player session status =
ACTIVE or RESERVED).
AvailablePlayerSessions – number of player session slots currently available in active game sessions
across the fleet, calculated by subtracting a game session's current player session count from its maximum player
session count. This number does include game sessions that are not currently accepting players (game session
PlayerSessionCreationPolicy = DENY_ALL).
ActiveInstances – number of instances currently running a game session.
IdleInstances – number of instances not currently running a game session.
String fleetId
Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.
String aliasId
Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.
String filterExpression
String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.
A filter expression can contain one or multiple conditions. Each condition consists of the following:
Operand -- Name of a game session attribute. Valid values are gameSessionName,
gameSessionId, creationTimeMillis, playerSessionCount,
maximumSessions, hasAvailablePlayerSessions.
Comparator -- Valid comparators are: =, <>, <,
>, <=, >=.
Value -- Value to be searched for. Values can be numbers, boolean values (true/false) or strings. String
values are case sensitive, enclosed in single quotes. Special characters must be escaped. Boolean and string
values can only be used with the comparators = and <>. For example, the following
filter expression searches on gameSessionName: "
FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".
To chain multiple conditions in a single expression, use the logical keywords AND, OR,
and NOT and parentheses as needed. For example: x AND y AND NOT z,
NOT (x OR y).
Session search evaluates conditions from left to right using the following precedence rules:
=, <>, <, >, <=,
>=
Parentheses
NOT
AND
OR
For example, this filter expression retrieves game sessions hosting at least ten players that have an open player
slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".
String sortExpression
Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:
Operand -- Name of a game session attribute. Valid values are gameSessionName,
gameSessionId, creationTimeMillis, playerSessionCount,
maximumSessions, hasAvailablePlayerSessions.
Order -- Valid sort orders are ASC (ascending) and DESC (descending).
For example, this sort expression returns the oldest active sessions first:
"SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are
returned at the end of the list.
Integer limit
Maximum number of results to return. Use this parameter with NextToken to get results as a set of
sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher
than 20.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> gameSessions
Collection of objects containing game session properties for each session matching the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
String launchPath
Location in the game build of the server executable. All game builds are installed on instances at the root
C:\game\..., so an executable file located at MyGame\latest\server.exe has a launch
path of "C:\game\MyGame\latest\server.exe".
String parameters
Optional list of parameters to pass to the server executable on launch.
Integer concurrentExecutions
Number of server processes using this configuration to run concurrently on an instance.
String aliasId
Unique identifier for a fleet alias. Specify the alias you want to update.
String name
Descriptive label associated with an alias. Alias names do not need to be unique.
String description
Human-readable description of an alias.
RoutingStrategy routingStrategy
Object specifying the fleet and routing type to use for the alias.
Alias alias
Object containing the updated alias configuration.
Build build
Object containing the updated build record.
String fleetId
Unique identifier for the fleet you want to update attribute metadata for.
String name
Descriptive label associated with a fleet. Fleet names do not need to be unique.
String description
Human-readable description of a fleet.
String newGameSessionProtectionPolicy
Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.
NoProtection – The game session can be terminated during a scale-down event.
FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a
scale-down event.
ResourceCreationLimitPolicy resourceCreationLimitPolicy
Policy that limits the number of game sessions an individual player can create over a span of time.
String fleetId
Unique identifier for the updated fleet.
String fleetId
Unique identifier for the fleet you want to update capacity for.
Integer desiredInstances
Number of EC2 instances you want this fleet to host.
Integer minSize
Minimum value allowed for the fleet's instance count. Default if not set is 0.
Integer maxSize
Maximum value allowed for the fleet's instance count. Default if not set is 1.
String fleetId
Unique identifier for the updated fleet.
String fleetId
Unique identifier for the fleet you want to update port settings for.
List<E> inboundPermissionAuthorizations
Collection of port settings to be added to the fleet record.
List<E> inboundPermissionRevocations
Collection of port settings to be removed from the fleet record.
String fleetId
Unique identifier for the updated fleet.
String gameSessionId
Unique identifier for the game session to update. Game session ID format is as follows: "arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an auto-generated string.
Integer maximumPlayerSessionCount
Maximum number of players that can be simultaneously connected to the game session.
String name
Descriptive label associated with a game session. Session names do not need to be unique.
String playerSessionCreationPolicy
Policy determining whether or not the game session accepts new players.
String protectionPolicy
Game session protection policy to apply to this game session only.
NoProtection – The game session can be terminated during a scale-down event.
FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a
scale-down event.
GameSession gameSession
Object containing the updated game session metadata.
String fleetId
Unique identifier of the fleet to update runtime configuration for.
RuntimeConfiguration runtimeConfiguration
Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.
RuntimeConfiguration runtimeConfiguration
The runtime configuration currently in force. If the update was successful, this object matches the one in the request.
Copyright © 2016. All rights reserved.