describeFleetPortSettings method

Future<DescribeFleetPortSettingsOutput> describeFleetPortSettings({ required String fleetId, })

Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet use connections that fall in this range.

To get a fleet's inbound connection permissions, specify the fleet's unique identifier. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift Fleets

Related operations

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

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

Parameter fleetId : A unique identifier for a fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

Implementation

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

  return DescribeFleetPortSettingsOutput.fromJson(jsonResponse.body);
}