Module Values.DescribeInstancesOutputSource

This API works with the following fleet types:EC2, Container Retrieves information about the EC2 instances in an Amazon GameLift Servers managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute and https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets. You can call this operation in the following ways: To get information on all instances in a fleet's home Region, specify the fleet ID. To get information on all instances in a fleet's remote location, specify the fleet ID and location name. To get information on a specific instance in a fleet, specify the fleet ID and instance ID. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, this operation returns Instance objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException. Learn more Remotely connect to fleet instances Debug fleet issues Related actions All APIs by task

Sourcetype nonrec t = {
  1. instances : InstanceList.t option;
    (*

    A collection of objects containing properties for each instance returned.

    *)
  2. 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 : ?instances:??? -> ?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 | `String of FleetId.t | `Timestamp of Timestamp.t ]) list ] list | `String of NonZeroAndMaxString.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