DescribeCompute
Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.
Request Syntax
{
"ComputeName": "string
",
"FleetId": "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.
In the following list, the required parameters are described first.
- ComputeName
-
A descriptive label that is associated with the compute resource registered to your fleet.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
[a-zA-Z0-9\-]+|^arn:.*:compute\/[a-zA-Z0-9\-]+
Required: Yes
- FleetId
-
A unique identifier for the fleet the compute is registered to.
Type: String
Pattern:
^fleet-\S+|^arn:.*:fleet\/fleet-\S+
Required: Yes
Response Syntax
{
"Compute": {
"ComputeArn": "string",
"ComputeName": "string",
"ComputeStatus": "string",
"CreationTime": number,
"DnsName": "string",
"FleetArn": "string",
"FleetId": "string",
"GameLiftServiceSdkEndpoint": "string",
"IpAddress": "string",
"Location": "string",
"OperatingSystem": "string",
"Type": "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.
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
- NotFoundException
-
THe requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
Examples
This example illustrates one usage of DescribeCompute.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: