Module Values.DescribeInstancesInputSource

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. fleetId : FleetIdOrArn.t;
    (*

    A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

    *)
  2. instanceId : InstanceId.t option;
    (*

    A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

    *)
  3. limit : PositiveInteger.t option;
    (*

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

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

    A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

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

    The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as us-west-2.

    *)
}
Sourceval context_ : string
Sourceval make : ?instanceId:??? -> ?limit:??? -> ?nextToken:??? -> ?location:??? -> fleetId:FleetIdOrArn.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of PositiveInteger.t | `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