GameLift / Client / describe_instances
Retrieves information about a fleet’s instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet’s home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet’s remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an
Instanceobject is returned for each requested instance. Instances are not returned in any particular order.
Remotely Access Fleet Instances
See also: AWS API Documentation
response = client.describe_instances( FleetId='string', InstanceId='string', Limit=123, NextToken='string', Location='string' )
FleetId (string) –
A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.
InstanceId (string) – A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.
Limit (integer) – The maximum number of results to return. Use this parameter with
NextTokento get results as a set of sequential pages.
NextToken (string) – 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.
Location (string) – The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as
- Return type:
Instances (list) –
A collection of objects containing properties for each instance returned.
Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In Amazon GameLift, a fleet can contain zero or more instances.
FleetId (string) –
A unique identifier for the fleet that the instance is in.
FleetArn (string) –
The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is
InstanceId (string) –
A unique identifier for the instance.
IpAddress (string) –
IP address that is assigned to the instance.
DnsName (string) –
The DNS identifier assigned to the instance that is running the game session. Values have the following format:
<unique identifier>.<region identifier>.amazongamelift.com.
ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
OperatingSystem (string) –
Operating system that is running on this instance.
Type (string) –
Amazon EC2 instance type that defines the computing resources of this instance.
Status (string) –
Current status of the instance. Possible statuses include the following:
PENDING – The instance is in the process of being created and launching server processes as defined in the fleet’s run-time configuration.
ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.
TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.
CreationTime (datetime) –
A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example
Location (string) –
The fleet location of the instance, expressed as an Amazon Web Services Region code, such as
NextToken (string) –
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.