Module Values.DescribeFleetLocationAttributesOutputSource

This API works with the following fleet types: EC2, Container Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity. This operation can be used in the following ways: To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested. To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order. When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting

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

    A unique identifier for the fleet that location attributes were requested for.

    *)
  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. locationAttributes : LocationAttributesList.t option;
    (*

    Location-specific information on the requested fleet's remote locations.

    *)
  4. nextToken : NonZeroAndMaxString.t option;
    (*

    A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

    *)
}
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:??? -> ?locationAttributes:??? -> ?nextToken:??? -> 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 * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `Structure of (string * [> `Enum of string | `String of LocationStringModel.t ]) list ]) list ] list | `String of FleetIdOrArn.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