DescribeInstances (smaws-clients.Smaws_Client

Module Smaws_Client_GameLift.DescribeInstances

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

Related actions

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `InternalServiceException of Types.internal_service_exception
  | `InvalidRequestException of Types.invalid_request_exception
  | `NotFoundException of Types.not_found_exception
  | `UnauthorizedException of Types.unauthorized_exception
  | `UnsupportedRegionException of Types.unsupported_region_exception ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_instances_input ->
  (Types.describe_instances_output,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `UnauthorizedException of Types.unauthorized_exception
    | `UnsupportedRegionException of Types.unsupported_region_exception ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_instances_input ->
  (Types.describe_instances_output Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `InternalServiceException of Types.internal_service_exception
    | `InvalidRequestException of Types.invalid_request_exception
    | `NotFoundException of Types.not_found_exception
    | `UnauthorizedException of Types.unauthorized_exception
    | `UnsupportedRegionException of Types.unsupported_region_exception ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result