Module Values.DescribeFleetPortSettingsOutputSource

This API works with the following fleet types: EC2, Container Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. Use this operation in the following ways: To retrieve the port settings for a fleet, identify the fleet's unique identifier. To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations. If successful, a set of IpPermission objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty. Learn more Setting up Amazon GameLift Servers fleets

Sourcetype nonrec t = {
  1. fleetId : FleetId.t option;
    (*

    A unique identifier for the fleet that was requested.

    *)
  2. fleetArn : FleetArn.t option;
    (*

    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

    *)
  3. inboundPermissions : IpPermissionsList.t option;
    (*

    The port settings for the requested fleet ID.

    *)
  4. updateStatus : LocationUpdateStatus.t option;
    (*

    The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

    *)
  5. location : LocationStringModel.t option;
    (*

    The requested fleet location, expressed as an Amazon Web Services Region code, such as us-west-2.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceException of InternalServiceException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `NotFoundException of NotFoundException.t
  4. | `UnauthorizedException of UnauthorizedException.t
  5. | `UnsupportedRegionException of UnsupportedRegionException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?fleetId:??? -> ?fleetArn:??? -> ?inboundPermissions:??? -> ?updateStatus:??? -> ?location:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `Integer of PortNumber.t | `String of IpRange.t ]) list ] list | `String of FleetId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t