describeRuntimeConfiguration method

Future<DescribeRuntimeConfigurationOutput> describeRuntimeConfiguration({ required String fleetId, })

Retrieves a fleet's runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance in the fleet.

To get a runtime configuration, specify the fleet's unique identifier. 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 GameLift Fleets

Running Multiple Processes on a Fleet

Related operations

• CreateFleet
• ListFleets
• DeleteFleet
• Describe fleets:
  • DescribeFleetAttributes
  • DescribeFleetCapacity
  • DescribeFleetPortSettings
  • DescribeFleetUtilization
  • DescribeRuntimeConfiguration
  • DescribeEC2InstanceLimits
  • DescribeFleetEvents
• UpdateFleetAttributes
• StartFleetActions or StopFleetActions

May throw UnauthorizedException. May throw NotFoundException. May throw InternalServiceException. May throw InvalidRequestException.

Parameter fleetId : A unique identifier for a fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Implementation

Future<DescribeRuntimeConfigurationOutput> describeRuntimeConfiguration({
  required String fleetId,
}) async {
  ArgumentError.checkNotNull(fleetId, 'fleetId');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.DescribeRuntimeConfiguration'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'FleetId': fleetId,
    },
  );

  return DescribeRuntimeConfigurationOutput.fromJson(jsonResponse.body);
}