Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCompute

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves information on the compute resources in an Amazon GameLift fleet.

To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages.

You can filter the result set by location.

If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information:

For EC2 fleets, this operation returns information about the EC2 instance. Compute names are instance IDs.
For ANYWHERE fleets, this operation returns the compute names and details provided when the compute was registered with RegisterCompute. The GameLiftServiceSdkEndpoint or GameLiftAgentEndpoint is included.
For CONTAINER fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names.

Request Syntax


{
   "FleetId": "string",
   "Limit": number,
   "Location": "string",
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

FleetId

A unique identifier for the fleet to retrieve compute resources for.

Type: String

Pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+

Required: Yes

Limit

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Location

The name of a location to retrieve compute resources for. For an Amazon GameLift Anywhere fleet, use a custom location. For a multi-location EC2 or container fleet, provide a Amazon Region or Local Zone code (for example: us-west-2 or us-west-2-lax-1).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[A-Za-z0-9\-]+

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


{
   "ComputeList": [ 
      { 
         "ComputeArn": "string",
         "ComputeName": "string",
         "ComputeStatus": "string",
         "ContainerAttributes": { 
            "ContainerPortMappings": [ 
               { 
                  "ConnectionPort": number,
                  "ContainerPort": number,
                  "Protocol": "string"
               }
            ]
         },
         "CreationTime": number,
         "DnsName": "string",
         "FleetArn": "string",
         "FleetId": "string",
         "GameLiftAgentEndpoint": "string",
         "GameLiftServiceSdkEndpoint": "string",
         "InstanceId": "string",
         "IpAddress": "string",
         "Location": "string",
         "OperatingSystem": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ComputeList

A list of compute resources in the specified fleet.

Type: Array of Compute objects

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400