Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.
To get the current runtime configuration for a fleet, provide the fleet ID.
If successful, a RuntimeConfiguration object is returned for the
requested fleet. If the requested fleet has been deleted, the result set is
empty.
Learn more
Setting up Amazon GameLift Servers fleets
Running multiple processes on a fleet
Request Syntax
{
"FleetId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- FleetId
-
A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$Required: Yes
Response Syntax
{
"RuntimeConfiguration": {
"GameSessionActivationTimeoutSeconds": number,
"MaxConcurrentGameSessionActivations": number,
"ServerProcesses": [
{
"ConcurrentExecutions": number,
"LaunchPath": "string",
"Parameters": "string"
}
]
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- RuntimeConfiguration
-
Instructions that describe how server processes are launched and maintained on computes in the fleet.
Type: RuntimeConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
Examples
Request the runtime configuration for a fleet
This example retrieves the current runtime configuration for a specified
fleet. As shown, the requested fleet is configured to run four concurrent
processes of the game server executable, one with debug mode turned on. The
property MaxConcurrentGameSessionActivations is set to the default
value, which places no limit on concurrent activations.
HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.
Sample Request
{
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa"
}Sample Response
{
"RuntimeConfiguration": {
"ServerProcesses": [
{
"LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe",
"Parameters": "+gamelift_start_server",
"ConcurrentExecutions": 3
},
{
"LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe",
"Parameters": "+gamelift_start_server +debug",
"ConcurrentExecutions": 1
}
],
"MaxConcurrentGameSessionActivations": 2147483647,
"GameSessionActivationTimeoutSeconds": 300
}
} See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
