Request Syntax Request Parameters Response Syntax Response Elements Errors Example See Also

DescribeInstances

Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related operations

DescribeInstances
GetInstanceAccess

Request Syntax


{
   "FleetId": "string",
   "InstanceId": "string",
   "Limit": number,
   "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 a fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

Type: String

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

Required: Yes

InstanceId

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Type: String

Pattern: [a-zA-Z0-9\.-]+

Required: No

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

NextToken

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. 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


{
   "Instances": [ 
      { 
         "CreationTime": number,
         "DnsName": "string",
         "FleetId": "string",
         "InstanceId": "string",
         "IpAddress": "string",
         "OperatingSystem": "string",
         "Status": "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.

Instances

A collection of objects containing properties for each instance returned.

Type: Array of Instance objects

NextToken

Token that indicates where to resume retrieving results on the next call to this action. 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

NotFoundException

A service resource associated with the request could not be found. Clients should not retry such requests.

HTTP Status Code: 400

UnauthorizedException

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

HTTP Status Code: 400

Example

Get data on a fleet instance

This example requests information on one instance in a fleet. Instances are not returned in any particular order. If you want to get data on all instances in a fleet, omit the Limit parameter.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request


POST / HTTP/1.1
Host: gamelift.us-west-2.amazonaws.com;
Accept-Encoding: identity
Content-Length: 105
User-Agent: aws-cli/1.11.36 Python/2.7.9 Windows/7 botocore/1.4.93
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256  Credential=AKIAIOSFODNN7EXAMPLE/20170406/us-west-2/gamelift/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
X-Amz-Date: 20170406T004805Z
X-Amz-Target: GameLift.DescribeInstances 
	
    {"FleetId": "fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa",
    "Limit": "1"
    }

CLI syntax:
    aws gamelift describe-instances --fleet-id "fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa" --limit 1

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: b34f8665-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1986
Date: Thu, 06 Apr 2017 00:48:07 GMT

{
    "Instances": [
        {
            "FleetId": "fleet-9999ffff-88ee-77dd-66cc-5555bbbb44aa",
            "InstanceId": "i-11111111a222b333c,
            "IpAddress": "192.0.2.0",
            "DnsName": "ec2-192-0-2-0.us-west-2.compute.amazonaws.com",
            "OperatingSystem": "WIN_2012",
            "Type": "c4.large",
            "Status": "Active",
            "CreationTime": 1515032347.867
        }
    ]
}