ListCompute - Amazon GameLift

ListCompute

Retrieves all compute resources registered to a fleet in your AWS account. You can filter the result set by location.

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 the compute resources are registered to.

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 the custom location that the compute resources are assigned to.

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", "CreationTime": number, "DnsName": "string", "FleetArn": "string", "FleetId": "string", "GameLiftServiceSdkEndpoint": "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 registered to the fleet you specified.

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

Examples

List compute resources

The following examples lists the compute resources registered to the fleet fleet-1234 in us-west-1

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: