DescribeCompute
Retrieves properties for a specific compute resource in an Amazon GameLift Servers fleet. You can list all computes in a fleet by calling ListCompute.
Request options
Provide the fleet ID and compute name. The compute name varies depending on the type of fleet.
-
For a compute in a managed EC2 fleet, provide an instance ID. Each instance in the fleet is a compute.
-
For a compute in a managed container fleet, provide a compute name. In a container fleet, each game server container group on a fleet instance is assigned a compute name.
-
For a compute in an Anywhere fleet, provide a registered compute name. Anywhere fleet computes are created when you register a hosting resource with the fleet.
Results
If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:
-
For a managed EC2 fleet, this operation returns information about the EC2 instance.
-
For a managed container fleet, this operation returns information about the container group and the instance it's running on.
-
For an Anywhere fleet, this operation returns information about the registered compute.
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.
Note
In the following list, the required parameters are described first.
- ComputeName
-
The unique identifier of the compute resource to retrieve properties for. For a managed container fleet or Anywhere fleet, use a compute name. For an EC2 fleet, use an instance ID. To retrieve a fleet's compute identifiers, call ListCompute.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?$|^arn:.*:compute\/[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?Required: Yes
- FleetId
-
A unique identifier for the fleet that the compute belongs to. You can use either the fleet ID or ARN value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$Required: Yes
Response Syntax
{
"Compute": {
"ComputeArn": "string",
"ComputeName": "string",
"ComputeStatus": "string",
"ContainerAttributes": [
{
"ContainerName": "string",
"ContainerRuntimeId": "string"
}
],
"CreationTime": number,
"DnsName": "string",
"FleetArn": "string",
"FleetId": "string",
"GameLiftAgentEndpoint": "string",
"GameLiftServiceSdkEndpoint": "string",
"GameServerContainerGroupDefinitionArn": "string",
"InstanceId": "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
- UnsupportedRegionException
-
The requested operation is not supported in the Region specified.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
