Table of Contents
A low-level client representing Amazon GameLift:
import boto3
client = boto3.client('gamelift')
These are the available methods:
Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE . This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.
To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING , where a new game session is created for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED , and processing is terminated. A new matchmaking request for these players can be submitted as needed.
See also: AWS API Documentation
Request Syntax
response = client.accept_match(
TicketId='string',
PlayerIds=[
'string',
],
AcceptanceType='ACCEPT'|'REJECT'
)
[REQUIRED]
Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE ; otherwise this request will fail.
[REQUIRED]
Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
[REQUIRED]
Player response to the proposed match.
dict
Response Syntax
{}
Response Structure
Check if an operation can be paginated.
Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.
Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.
To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias .
See also: AWS API Documentation
Request Syntax
response = client.create_alias(
Name='string',
Description='string',
RoutingStrategy={
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
}
)
[REQUIRED]
Descriptive label that is associated with an alias. Alias names do not need to be unique.
[REQUIRED]
Object that specifies the fleet and routing type to use for the alias.
Type of routing strategy.
Possible routing types include the following:
Unique identifier for a fleet that the alias points to.
Message text to be used with a terminal routing strategy.
dict
Response Syntax
{
'Alias': {
'AliasId': 'string',
'Name': 'string',
'AliasArn': 'string',
'Description': 'string',
'RoutingStrategy': {
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Alias (dict) --
Object that describes the newly created alias record.
AliasId (string) --
Unique identifier for an alias; alias IDs are unique within a region.
Name (string) --
Descriptive label that is associated with an alias. Alias names do not need to be unique.
AliasArn (string) --
Unique identifier for an alias; alias ARNs are unique across all regions.
Description (string) --
Human-readable description of an alias.
RoutingStrategy (dict) --
Alias configuration for the alias, including routing type and settings.
Type (string) --
Type of routing strategy.
Possible routing types include the following:
FleetId (string) --
Unique identifier for a fleet that the alias points to.
Message (string) --
Message text to be used with a terminal routing strategy.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
LastUpdatedTime (datetime) --
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.
Game server binaries must be combined into a .zip file for use with Amazon GameLift. See Uploading Your Game for more information.
Warning
To create new builds quickly and easily, use the AWS CLI command ** upload-build ** . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. See Upload Build Files to Amazon GameLift for more help.
The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:
If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.
See also: AWS API Documentation
Request Syntax
response = client.create_build(
Name='string',
Version='string',
StorageLocation={
'Bucket': 'string',
'Key': 'string',
'RoleArn': 'string'
},
OperatingSystem='WINDOWS_2012'|'AMAZON_LINUX'
)
Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in.
Amazon S3 bucket identifier. This is the name of your S3 bucket.
Name of the zip file containing your build files.
Amazon Resource Name (ARN ) for the access role that allows Amazon GameLift to access your S3 bucket.
dict
Response Syntax
{
'Build': {
'BuildId': 'string',
'Name': 'string',
'Version': 'string',
'Status': 'INITIALIZED'|'READY'|'FAILED',
'SizeOnDisk': 123,
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'CreationTime': datetime(2015, 1, 1)
},
'UploadCredentials': {
'AccessKeyId': 'string',
'SecretAccessKey': 'string',
'SessionToken': 'string'
},
'StorageLocation': {
'Bucket': 'string',
'Key': 'string',
'RoleArn': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Build (dict) --
The newly created build record, including a unique build ID and status.
BuildId (string) --
Unique identifier for a build.
Name (string) --
Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild .
Version (string) --
Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild .
Status (string) --
Current status of the build.
Possible build statuses include the following:
SizeOnDisk (integer) --
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED , this value is 0.
OperatingSystem (string) --
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
UploadCredentials (dict) --
This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials .
AccessKeyId (string) --
Temporary key allowing access to the Amazon GameLift S3 account.
SecretAccessKey (string) --
Temporary secret key allowing access to the Amazon GameLift S3 account.
SessionToken (string) --
Token used to associate a specific build ID with the files uploaded using these credentials.
StorageLocation (dict) --
Amazon S3 location for your game build file, including bucket name and key.
Bucket (string) --
Amazon S3 bucket identifier. This is the name of your S3 bucket.
Key (string) --
Name of the zip file containing your build files.
RoleArn (string) --
Amazon Resource Name (ARN ) for the access role that allows Amazon GameLift to access your S3 bucket.
Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types ), and deploy your game build to the fleet.
To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type, (3) the build ID for your game build, and (4) a run-time configuration, which specifies the server processes to run on each instance in the fleet. If fleet type is not set, the new fleet will use on-demand instances by default.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:
Learn more
See Amazon GameLift Developer Guide topics in Working with Fleets .
Related operations
See also: AWS API Documentation
Request Syntax
response = client.create_fleet(
Name='string',
Description='string',
BuildId='string',
ServerLaunchPath='string',
ServerLaunchParameters='string',
LogPaths=[
'string',
],
EC2InstanceType='t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
EC2InboundPermissions=[
{
'FromPort': 123,
'ToPort': 123,
'IpRange': 'string',
'Protocol': 'TCP'|'UDP'
},
],
NewGameSessionProtectionPolicy='NoProtection'|'FullProtection',
RuntimeConfiguration={
'ServerProcesses': [
{
'LaunchPath': 'string',
'Parameters': 'string',
'ConcurrentExecutions': 123
},
],
'MaxConcurrentGameSessionActivations': 123,
'GameSessionActivationTimeoutSeconds': 123
},
ResourceCreationLimitPolicy={
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
MetricGroups=[
'string',
],
PeerVpcAwsAccountId='string',
PeerVpcId='string',
FleetType='ON_DEMAND'|'SPOT'
)
[REQUIRED]
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
[REQUIRED]
Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters . See more information in the Server API Reference .
[REQUIRED]
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.
Starting value for a range of allowed port numbers.
Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort .
Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask] " or optionally the shortened version "0.0.0.0/[subnet mask] ".
Network communication protocol used by the fleet.
Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes , but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession .
Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters ; requests that contain values for these parameters instead of a run-time configuration will continue to work.)
Collection of server process configurations that describe which server processes to run on each instance in a fleet.
A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's `` RuntimeConfiguration `` .
Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game , and for Linux instances /local/game . A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe ". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe ".
Optional list of parameters to pass to the server executable on launch.
Number of server processes using this configuration to run concurrently on an instance.
Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING . If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED .
Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
Maximum number of game sessions that an individual can create during the policy period.
Time span used in evaluating the resource creation limit policy.
Name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.
dict
Response Syntax
{
'FleetAttributes': {
'FleetId': 'string',
'FleetArn': 'string',
'FleetType': 'ON_DEMAND'|'SPOT',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'Description': 'string',
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED',
'BuildId': 'string',
'ServerLaunchPath': 'string',
'ServerLaunchParameters': 'string',
'LogPaths': [
'string',
],
'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'ResourceCreationLimitPolicy': {
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
'MetricGroups': [
'string',
],
'StoppedActions': [
'AUTO_SCALING',
]
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetAttributes (dict) --
Properties for the newly created fleet.
FleetId (string) --
Unique identifier for a fleet.
FleetArn (string) --
Identifier for a fleet that is unique across all regions.
FleetType (string) --
Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.
InstanceType (string) --
EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.
Description (string) --
Human-readable description of the fleet.
Name (string) --
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the fleet.
Possible fleet statuses include the following:
BuildId (string) --
Unique identifier for a build.
ServerLaunchPath (string) --
Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration .
ServerLaunchParameters (string) --
Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration .
LogPaths (list) --
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide . If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
NewGameSessionProtectionPolicy (string) --
Type of game session protection to set for all new instances started in the fleet.
OperatingSystem (string) --
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
ResourceCreationLimitPolicy (dict) --
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
NewGameSessionsPerCreator (integer) --
Maximum number of game sessions that an individual can create during the policy period.
PolicyPeriodInMinutes (integer) --
Time span used in evaluating the resource creation limit policy.
MetricGroups (list) --
Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.
StoppedActions (list) --
List of fleet actions that have been suspended using StopFleetActions . This includes auto-scaling.
Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.
To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.
Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.
Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.
Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.
Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
See also: AWS API Documentation
Request Syntax
response = client.create_game_session(
FleetId='string',
AliasId='string',
MaximumPlayerSessionCount=123,
Name='string',
GameProperties=[
{
'Key': 'string',
'Value': 'string'
},
],
CreatorId='string',
GameSessionId='string',
IdempotencyToken='string',
GameSessionData='string'
)
[REQUIRED]
Maximum number of players that can be connected simultaneously to the game session.
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Game property identifier.
Game property value.
dict
Response Syntax
{
'GameSession': {
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSession (dict) --
Object that describes the newly created game session record.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.
Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.
Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.
To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.
See also: AWS API Documentation
Request Syntax
response = client.create_game_session_queue(
Name='string',
TimeoutInSeconds=123,
PlayerLatencyPolicies=[
{
'MaximumIndividualPlayerLatencyMilliseconds': 123,
'PolicyDurationSeconds': 123
},
],
Destinations=[
{
'DestinationArn': 'string'
},
]
)
[REQUIRED]
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.
dict
Response Syntax
{
'GameSessionQueue': {
'Name': 'string',
'GameSessionQueueArn': 'string',
'TimeoutInSeconds': 123,
'PlayerLatencyPolicies': [
{
'MaximumIndividualPlayerLatencyMilliseconds': 123,
'PolicyDurationSeconds': 123
},
],
'Destinations': [
{
'DestinationArn': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionQueue (dict) --
Object that describes the newly created game session queue.
Name (string) --
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
GameSessionQueueArn (string) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
TimeoutInSeconds (integer) --
Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
PlayerLatencyPolicies (list) --
Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
(dict) --
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
MaximumIndividualPlayerLatencyMilliseconds (integer) --
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
PolicyDurationSeconds (integer) --
The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
Destinations (list) --
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
(dict) --
Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
DestinationArn (string) --
Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.
Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket ( StartMatchmaking or StartMatchBackfill ) specifies a configuration for the match and provides player attributes to support the configuration being used.
To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.
Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.
Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking ; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking ). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.
See also: AWS API Documentation
Request Syntax
response = client.create_matchmaking_configuration(
Name='string',
Description='string',
GameSessionQueueArns=[
'string',
],
RequestTimeoutSeconds=123,
AcceptanceTimeoutSeconds=123,
AcceptanceRequired=True|False,
RuleSetName='string',
NotificationTarget='string',
AdditionalPlayerCount=123,
CustomEventData='string',
GameProperties=[
{
'Key': 'string',
'Value': 'string'
},
],
GameSessionData='string'
)
[REQUIRED]
Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
[REQUIRED]
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
[REQUIRED]
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
[REQUIRED]
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
[REQUIRED]
Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Game property identifier.
Game property value.
dict
Response Syntax
{
'Configuration': {
'Name': 'string',
'Description': 'string',
'GameSessionQueueArns': [
'string',
],
'RequestTimeoutSeconds': 123,
'AcceptanceTimeoutSeconds': 123,
'AcceptanceRequired': True|False,
'RuleSetName': 'string',
'NotificationTarget': 'string',
'AdditionalPlayerCount': 123,
'CustomEventData': 'string',
'CreationTime': datetime(2015, 1, 1),
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'GameSessionData': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Configuration (dict) --
Object that describes the newly created matchmaking configuration.
Name (string) --
Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
Description (string) --
Descriptive label that is associated with matchmaking configuration.
GameSessionQueueArns (list) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
RequestTimeoutSeconds (integer) --
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
AcceptanceTimeoutSeconds (integer) --
Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
AcceptanceRequired (boolean) --
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
RuleSetName (string) --
Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.
NotificationTarget (string) --
SNS topic ARN that is set up to receive matchmaking notifications.
AdditionalPlayerCount (integer) --
Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
CustomEventData (string) --
Information to attached to all events related to the matchmaking configuration.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration .
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they will be used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.
Learn more
Related operations
See also: AWS API Documentation
Request Syntax
response = client.create_matchmaking_rule_set(
Name='string',
RuleSetBody='string'
)
[REQUIRED]
Unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. (Note: The rule set name is different from the optional "name" field in the rule set body.)
[REQUIRED]
Collection of matchmaking rules, formatted as a JSON string. Note that comments are not allowed in JSON, but most elements support a description field.
dict
Response Syntax
{
'RuleSet': {
'RuleSetName': 'string',
'RuleSetBody': 'string',
'CreationTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
RuleSet (dict) --
Object that describes the newly created matchmaking rule set.
RuleSetName (string) --
Unique identifier for a matchmaking rule set
RuleSetBody (string) --
Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL , and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions .
To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
See also: AWS API Documentation
Request Syntax
response = client.create_player_session(
GameSessionId='string',
PlayerId='string',
PlayerData='string'
)
[REQUIRED]
Unique identifier for the game session to add a player to.
[REQUIRED]
Unique identifier for a player. Player IDs are developer-defined.
dict
Response Syntax
{
'PlayerSession': {
'PlayerSessionId': 'string',
'PlayerId': 'string',
'GameSessionId': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'RESERVED'|'ACTIVE'|'COMPLETED'|'TIMEDOUT',
'IpAddress': 'string',
'Port': 123,
'PlayerData': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
PlayerSession (dict) --
Object that describes the newly created player session record.
PlayerSessionId (string) --
Unique identifier for a player session.
PlayerId (string) --
Unique identifier for a player that is associated with this player session.
GameSessionId (string) --
Unique identifier for the game session that the player session is connected to.
FleetId (string) --
Unique identifier for a fleet that the player's game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the player session.
Possible player session statuses include the following:
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
PlayerData (string) --
Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL , and have an open player slot. To add a single player to a game session, use CreatePlayerSession .
To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. Player sessions cannot be updated.
Available in Amazon GameLift Local.
See also: AWS API Documentation
Request Syntax
response = client.create_player_sessions(
GameSessionId='string',
PlayerIds=[
'string',
],
PlayerDataMap={
'string': 'string'
}
)
[REQUIRED]
Unique identifier for the game session to add players to.
[REQUIRED]
List of unique identifiers for the players to be added.
Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the PlayerIds parameter are ignored.
dict
Response Syntax
{
'PlayerSessions': [
{
'PlayerSessionId': 'string',
'PlayerId': 'string',
'GameSessionId': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'RESERVED'|'ACTIVE'|'COMPLETED'|'TIMEDOUT',
'IpAddress': 'string',
'Port': 123,
'PlayerData': 'string'
},
]
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
PlayerSessions (list) --
Collection of player session objects created for the added players.
(dict) --
Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED ) or actual player activity in a game session (status ACTIVE ). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.
When a player disconnects, the player session status changes to COMPLETED . Once the session ends, the player session object is retained for 30 days and then removed.
PlayerSessionId (string) --
Unique identifier for a player session.
PlayerId (string) --
Unique identifier for a player that is associated with this player session.
GameSessionId (string) --
Unique identifier for the game session that the player session is connected to.
FleetId (string) --
Unique identifier for a fleet that the player's game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the player session.
Possible player session statuses include the following:
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
PlayerData (string) --
Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets .
You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions.
To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.
To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift.
The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization . You must create or delete the peering connection while the authorization is valid.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_peering_authorization(
GameLiftAwsAccountId='string',
PeerVpcId='string'
)
[REQUIRED]
Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.
[REQUIRED]
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
dict
Response Syntax
{
'VpcPeeringAuthorization': {
'GameLiftAwsAccountId': 'string',
'PeerVpcAwsAccountId': 'string',
'PeerVpcId': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
VpcPeeringAuthorization (dict) --
Details on the requested VPC peering authorization, including expiration.
GameLiftAwsAccountId (string) --
Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.
PeerVpcAwsAccountId (string) --
PeerVpcId (string) --
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
CreationTime (datetime) --
Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
ExpirationTime (datetime) --
Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets .
Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.
To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_peering_connection(
FleetId='string',
PeerVpcAwsAccountId='string',
PeerVpcId='string'
)
[REQUIRED]
Unique identifier for a fleet. This tells Amazon GameLift which GameLift VPC to peer with.
[REQUIRED]
Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.
[REQUIRED]
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
dict
Response Syntax
{}
Response Structure
Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_alias(
AliasId='string'
)
[REQUIRED]
Unique identifier for a fleet alias. Specify the alias you want to delete.
Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
See also: AWS API Documentation
Request Syntax
response = client.delete_build(
BuildId='string'
)
[REQUIRED]
Unique identifier for a build to delete.
Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity .
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
See also: AWS API Documentation
Request Syntax
response = client.delete_fleet(
FleetId='string'
)
[REQUIRED]
Unique identifier for a fleet to be deleted.
Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.
See also: AWS API Documentation
Request Syntax
response = client.delete_game_session_queue(
Name='string'
)
[REQUIRED]
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
{}
Response Structure
Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.
See also: AWS API Documentation
Request Syntax
response = client.delete_matchmaking_configuration(
Name='string'
)
[REQUIRED]
Unique identifier for a matchmaking configuration
{}
Response Structure
Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.
Learn more
Related operations
See also: AWS API Documentation
Request Syntax
response = client.delete_matchmaking_rule_set(
Name='string'
)
[REQUIRED]
Unique identifier for a matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.)
{}
Response Structure
Represents the returned data in response to a request action.
Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
To temporarily suspend scaling policies, call StopFleetActions . This operation suspends all policies for the fleet.
See also: AWS API Documentation
Request Syntax
response = client.delete_scaling_policy(
Name='string',
FleetId='string'
)
[REQUIRED]
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
[REQUIRED]
Unique identifier for a fleet to be deleted.
None
Cancels a pending VPC peering authorization for the specified VPC. If the authorization has already been used to create a peering connection, call DeleteVpcPeeringConnection to remove the connection.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_peering_authorization(
GameLiftAwsAccountId='string',
PeerVpcId='string'
)
[REQUIRED]
Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.
[REQUIRED]
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
dict
Response Syntax
{}
Response Structure
Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization .
Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_peering_connection(
FleetId='string',
VpcPeeringConnectionId='string'
)
[REQUIRED]
Unique identifier for a fleet. This value must match the fleet ID referenced in the VPC peering connection record.
[REQUIRED]
Unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections .
dict
Response Syntax
{}
Response Structure
Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias .
To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_alias(
AliasId='string'
)
[REQUIRED]
Unique identifier for a fleet alias. Specify the alias you want to retrieve.
{
'Alias': {
'AliasId': 'string',
'Name': 'string',
'AliasArn': 'string',
'Description': 'string',
'RoutingStrategy': {
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
Represents the returned data in response to a request action.
Object that contains the requested alias.
Unique identifier for an alias; alias IDs are unique within a region.
Descriptive label that is associated with an alias. Alias names do not need to be unique.
Unique identifier for an alias; alias ARNs are unique across all regions.
Human-readable description of an alias.
Alias configuration for the alias, including routing type and settings.
Type of routing strategy.
Possible routing types include the following:
Unique identifier for a fleet that the alias points to.
Message text to be used with a terminal routing strategy.
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_build(
BuildId='string'
)
[REQUIRED]
Unique identifier for a build to retrieve properties for.
{
'Build': {
'BuildId': 'string',
'Name': 'string',
'Version': 'string',
'Status': 'INITIALIZED'|'READY'|'FAILED',
'SizeOnDisk': 123,
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'CreationTime': datetime(2015, 1, 1)
}
}
Response Structure
Represents the returned data in response to a request action.
Set of properties describing the requested build.
Unique identifier for a build.
Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild .
Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild .
Current status of the build.
Possible build statuses include the following:
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED , this value is 0.
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Retrieves the following information for the specified EC2 instance type:
Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).
See also: AWS API Documentation
Request Syntax
response = client.describe_ec2_instance_limits(
EC2InstanceType='t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'
)
{
'EC2InstanceLimits': [
{
'EC2InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'CurrentInstances': 123,
'InstanceLimit': 123
},
]
}
Response Structure
Represents the returned data in response to a request action.
Object that contains the maximum number of instances for the specified instance type.
Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits .
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
Number of instances of the specified type that are currently in use by this AWS account.
Number of instances allowed.
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Note
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_attributes(
FleetIds=[
'string',
],
Limit=123,
NextToken='string'
)
Unique identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.
dict
Response Syntax
{
'FleetAttributes': [
{
'FleetId': 'string',
'FleetArn': 'string',
'FleetType': 'ON_DEMAND'|'SPOT',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'Description': 'string',
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED',
'BuildId': 'string',
'ServerLaunchPath': 'string',
'ServerLaunchParameters': 'string',
'LogPaths': [
'string',
],
'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'ResourceCreationLimitPolicy': {
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
'MetricGroups': [
'string',
],
'StoppedActions': [
'AUTO_SCALING',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetAttributes (list) --
Collection of objects containing attribute metadata for each requested fleet ID.
(dict) --
General properties describing a fleet.
FleetId (string) --
Unique identifier for a fleet.
FleetArn (string) --
Identifier for a fleet that is unique across all regions.
FleetType (string) --
Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.
InstanceType (string) --
EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.
Description (string) --
Human-readable description of the fleet.
Name (string) --
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the fleet.
Possible fleet statuses include the following:
BuildId (string) --
Unique identifier for a build.
ServerLaunchPath (string) --
Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration .
ServerLaunchParameters (string) --
Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration .
LogPaths (list) --
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide . If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
NewGameSessionProtectionPolicy (string) --
Type of game session protection to set for all new instances started in the fleet.
OperatingSystem (string) --
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
ResourceCreationLimitPolicy (dict) --
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
NewGameSessionsPerCreator (integer) --
Maximum number of game sessions that an individual can create during the policy period.
PolicyPeriodInMinutes (integer) --
Time span used in evaluating the resource creation limit policy.
MetricGroups (list) --
Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.
StoppedActions (list) --
List of fleet actions that have been suspended using StopFleetActions . This includes auto-scaling.
NextToken (string) --
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.
Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Note
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_capacity(
FleetIds=[
'string',
],
Limit=123,
NextToken='string'
)
Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.
dict
Response Syntax
{
'FleetCapacity': [
{
'FleetId': 'string',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'InstanceCounts': {
'DESIRED': 123,
'MINIMUM': 123,
'MAXIMUM': 123,
'PENDING': 123,
'ACTIVE': 123,
'IDLE': 123,
'TERMINATING': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetCapacity (list) --
Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
(dict) --
Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
FleetId (string) --
Unique identifier for a fleet.
InstanceType (string) --
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
InstanceCounts (dict) --
Current status of fleet capacity.
DESIRED (integer) --
Ideal number of active instances in the fleet.
MINIMUM (integer) --
Minimum value allowed for the fleet's instance count.
MAXIMUM (integer) --
Maximum value allowed for the fleet's instance count.
PENDING (integer) --
Number of instances in the fleet that are starting but not yet active.
ACTIVE (integer) --
Actual number of active instances in the fleet.
IDLE (integer) --
Number of active instances in the fleet that are not currently hosting a game session.
TERMINATING (integer) --
Number of instances in the fleet that are no longer active but haven't yet been terminated.
NextToken (string) --
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.
Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_events(
FleetId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Limit=123,
NextToken='string'
)
[REQUIRED]
Unique identifier for a fleet to get event logs for.
dict
Response Syntax
{
'Events': [
{
'EventId': 'string',
'ResourceId': 'string',
'EventCode': 'GENERIC_EVENT'|'FLEET_CREATED'|'FLEET_DELETED'|'FLEET_SCALING_EVENT'|'FLEET_STATE_DOWNLOADING'|'FLEET_STATE_VALIDATING'|'FLEET_STATE_BUILDING'|'FLEET_STATE_ACTIVATING'|'FLEET_STATE_ACTIVE'|'FLEET_STATE_ERROR'|'FLEET_INITIALIZATION_FAILED'|'FLEET_BINARY_DOWNLOAD_FAILED'|'FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND'|'FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE'|'FLEET_VALIDATION_TIMED_OUT'|'FLEET_ACTIVATION_FAILED'|'FLEET_ACTIVATION_FAILED_NO_INSTANCES'|'FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED'|'SERVER_PROCESS_INVALID_PATH'|'SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT'|'SERVER_PROCESS_PROCESS_READY_TIMEOUT'|'SERVER_PROCESS_CRASHED'|'SERVER_PROCESS_TERMINATED_UNHEALTHY'|'SERVER_PROCESS_FORCE_TERMINATED'|'SERVER_PROCESS_PROCESS_EXIT_TIMEOUT'|'GAME_SESSION_ACTIVATION_TIMEOUT'|'FLEET_CREATION_EXTRACTING_BUILD'|'FLEET_CREATION_RUNNING_INSTALLER'|'FLEET_CREATION_VALIDATING_RUNTIME_CONFIG'|'FLEET_VPC_PEERING_SUCCEEDED'|'FLEET_VPC_PEERING_FAILED'|'FLEET_VPC_PEERING_DELETED'|'INSTANCE_INTERRUPTED',
'Message': 'string',
'EventTime': datetime(2015, 1, 1),
'PreSignedLogUrl': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Events (list) --
Collection of objects containing event log entries for the specified fleet.
(dict) --
Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.
EventId (string) --
Unique identifier for a fleet event.
ResourceId (string) --
Unique identifier for an event resource, such as a fleet ID.
EventCode (string) --
Type of event being logged. The following events are currently in use:
Fleet creation events:
VPC peering events:
Spot instance events:
Other fleet events:
Message (string) --
Additional information related to the event.
EventTime (datetime) --
Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
PreSignedLogUrl (string) --
Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.
NextToken (string) --
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.
Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_port_settings(
FleetId='string'
)
[REQUIRED]
Unique identifier for a fleet to retrieve port settings for.
{
'InboundPermissions': [
{
'FromPort': 123,
'ToPort': 123,
'IpRange': 'string',
'Protocol': 'TCP'|'UDP'
},
]
}
Response Structure
Represents the returned data in response to a request action.
Object that contains port settings for the requested fleet ID.
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.
Starting value for a range of allowed port numbers.
Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort .
Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask] " or optionally the shortened version "0.0.0.0/[subnet mask] ".
Network communication protocol used by the fleet.
Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Note
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet_utilization(
FleetIds=[
'string',
],
Limit=123,
NextToken='string'
)
Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.
dict
Response Syntax
{
'FleetUtilization': [
{
'FleetId': 'string',
'ActiveServerProcessCount': 123,
'ActiveGameSessionCount': 123,
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetUtilization (list) --
Collection of objects containing utilization information for each requested fleet ID.
(dict) --
Current status of fleet utilization, including the number of game and player sessions being hosted.
FleetId (string) --
Unique identifier for a fleet.
ActiveServerProcessCount (integer) --
Number of server processes in an ACTIVE status currently running across all instances in the fleet
ActiveGameSessionCount (integer) --
Number of active game sessions currently being hosted on all instances in the fleet.
CurrentPlayerSessionCount (integer) --
Number of active player sessions currently being hosted on all instances in the fleet.
MaximumPlayerSessionCount (integer) --
Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.
NextToken (string) --
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.
Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
See also: AWS API Documentation
Request Syntax
response = client.describe_game_session_details(
FleetId='string',
GameSessionId='string',
AliasId='string',
StatusFilter='string',
Limit=123,
NextToken='string'
)
dict
Response Syntax
{
'GameSessionDetails': [
{
'GameSession': {
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
},
'ProtectionPolicy': 'NoProtection'|'FullProtection'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionDetails (list) --
Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
(dict) --
A game session's properties plus the protection policy currently in force.
GameSession (dict) --
Object that describes a game session.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
ProtectionPolicy (string) --
Current status of protection for the game session.
NextToken (string) --
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.
Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_game_session_placement(
PlacementId='string'
)
[REQUIRED]
Unique identifier for a game session placement to retrieve.
{
'GameSessionPlacement': {
'PlacementId': 'string',
'GameSessionQueueName': 'string',
'Status': 'PENDING'|'FULFILLED'|'CANCELLED'|'TIMED_OUT',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'MaximumPlayerSessionCount': 123,
'GameSessionName': 'string',
'GameSessionId': 'string',
'GameSessionArn': 'string',
'GameSessionRegion': 'string',
'PlayerLatencies': [
{
'PlayerId': 'string',
'RegionIdentifier': 'string',
'LatencyInMilliseconds': ...
},
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'IpAddress': 'string',
'Port': 123,
'PlacedPlayerSessions': [
{
'PlayerId': 'string',
'PlayerSessionId': 'string'
},
],
'GameSessionData': 'string',
'MatchmakerData': 'string'
}
}
Response Structure
Represents the returned data in response to a request action.
Object that describes the requested game session placement.
Unique identifier for a game session placement.
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
Current status of the game session placement request.
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Game property identifier.
Game property value.
Maximum number of players that can be connected simultaneously to the game session.
Descriptive label that is associated with a game session. Session names do not need to be unique.
Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED ).
Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED ). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.
Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED ).
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement . This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.
Unique identifier for a player associated with the latency data.
Name of the region that is associated with the latency value.
Amount of time that represents the time lag experienced by the player when connected to the specified region.
Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Time stamp indicating when this request was completed, canceled, or timed out.
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED ).
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED ).
Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED ). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
Unique identifier for a player that is associated with this player session.
Unique identifier for a player session.
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data .
Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region.
See also: AWS API Documentation
Request Syntax
response = client.describe_game_session_queues(
Names=[
'string',
],
Limit=123,
NextToken='string'
)
List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.
dict
Response Syntax
{
'GameSessionQueues': [
{
'Name': 'string',
'GameSessionQueueArn': 'string',
'TimeoutInSeconds': 123,
'PlayerLatencyPolicies': [
{
'MaximumIndividualPlayerLatencyMilliseconds': 123,
'PolicyDurationSeconds': 123
},
],
'Destinations': [
{
'DestinationArn': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionQueues (list) --
Collection of objects that describes the requested game session queues.
(dict) --
Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
Name (string) --
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
GameSessionQueueArn (string) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
TimeoutInSeconds (integer) --
Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
PlayerLatencyPolicies (list) --
Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
(dict) --
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
MaximumIndividualPlayerLatencyMilliseconds (integer) --
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
PolicyDurationSeconds (integer) --
The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
Destinations (list) --
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
(dict) --
Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
DestinationArn (string) --
Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.
NextToken (string) --
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.
Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails .
To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.
Available in Amazon GameLift Local.
See also: AWS API Documentation
Request Syntax
response = client.describe_game_sessions(
FleetId='string',
GameSessionId='string',
AliasId='string',
StatusFilter='string',
Limit=123,
NextToken='string'
)
dict
Response Syntax
{
'GameSessions': [
{
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessions (list) --
Collection of objects containing game session properties for each session matching the request.
(dict) --
Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED .
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
NextToken (string) --
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.
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.
See also: AWS API Documentation
Request Syntax
response = client.describe_instances(
FleetId='string',
InstanceId='string',
Limit=123,
NextToken='string'
)
[REQUIRED]
Unique identifier for a fleet to retrieve instance information for.
dict
Response Syntax
{
'Instances': [
{
'FleetId': 'string',
'InstanceId': 'string',
'IpAddress': 'string',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'Status': 'PENDING'|'ACTIVE'|'TERMINATING',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Instances (list) --
Collection of objects containing properties for each instance returned.
(dict) --
Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.
FleetId (string) --
Unique identifier for a fleet that the instance is in.
InstanceId (string) --
Unique identifier for an instance.
IpAddress (string) --
IP address assigned to the instance.
OperatingSystem (string) --
Operating system that is running on this instance.
Type (string) --
EC2 instance type that defines the computing resources of this instance.
Status (string) --
Current status of the instance. Possible statuses include the following:
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
NextToken (string) --
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.
Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.
You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking .
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
See also: AWS API Documentation
Request Syntax
response = client.describe_matchmaking(
TicketIds=[
'string',
]
)
[REQUIRED]
Unique identifier for a matchmaking ticket. You can include up to 10 ID values.
{
'TicketList': [
{
'TicketId': 'string',
'ConfigurationName': 'string',
'Status': 'CANCELLED'|'COMPLETED'|'FAILED'|'PLACING'|'QUEUED'|'REQUIRES_ACCEPTANCE'|'SEARCHING'|'TIMED_OUT',
'StatusReason': 'string',
'StatusMessage': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Players': [
{
'PlayerId': 'string',
'PlayerAttributes': {
'string': {
'S': 'string',
'N': 123.0,
'SL': [
'string',
],
'SDM': {
'string': 123.0
}
}
},
'Team': 'string',
'LatencyInMs': {
'string': 123
}
},
],
'GameSessionConnectionInfo': {
'GameSessionArn': 'string',
'IpAddress': 'string',
'Port': 123,
'MatchedPlayerSessions': [
{
'PlayerId': 'string',
'PlayerSessionId': 'string'
},
]
},
'EstimatedWaitTime': 123
},
]
}
Response Structure
Represents the returned data in response to a request action.
Collection of existing matchmaking ticket objects matching the request.
Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking . Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.
Unique identifier for a matchmaking ticket.
Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
Current status of the matchmaking request.
Note
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.
Additional information about the current status.
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED , the Player objects include the team the players were assigned to in the resulting match.
Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.
Unique identifier for a player
Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}} .
Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.
For single string values. Maximum string length is 100 characters.
For number values, expressed as double.
For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.
Amazon Resource Name (ARN ) that is assigned to a game session and uniquely identifies it.
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Collection of player session IDs, one for each player ID that was included in the original matchmaking request.
Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.
When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.
Unique identifier for a player
Unique identifier for a player session
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
See also: AWS API Documentation
Request Syntax
response = client.describe_matchmaking_configurations(
Names=[
'string',
],
RuleSetName='string',
Limit=123,
NextToken='string'
)
Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.
dict
Response Syntax
{
'Configurations': [
{
'Name': 'string',
'Description': 'string',
'GameSessionQueueArns': [
'string',
],
'RequestTimeoutSeconds': 123,
'AcceptanceTimeoutSeconds': 123,
'AcceptanceRequired': True|False,
'RuleSetName': 'string',
'NotificationTarget': 'string',
'AdditionalPlayerCount': 123,
'CustomEventData': 'string',
'CreationTime': datetime(2015, 1, 1),
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'GameSessionData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Configurations (list) --
Collection of requested matchmaking configuration objects.
(dict) --
Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.
Name (string) --
Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
Description (string) --
Descriptive label that is associated with matchmaking configuration.
GameSessionQueueArns (list) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
RequestTimeoutSeconds (integer) --
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
AcceptanceTimeoutSeconds (integer) --
Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
AcceptanceRequired (boolean) --
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
RuleSetName (string) --
Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.
NotificationTarget (string) --
SNS topic ARN that is set up to receive matchmaking notifications.
AdditionalPlayerCount (integer) --
Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
CustomEventData (string) --
Information to attached to all events related to the matchmaking configuration.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
NextToken (string) --
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.
Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
Related operations
See also: AWS API Documentation
Request Syntax
response = client.describe_matchmaking_rule_sets(
Names=[
'string',
],
Limit=123,
NextToken='string'
)
List of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.)
dict
Response Syntax
{
'RuleSets': [
{
'RuleSetName': 'string',
'RuleSetBody': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
RuleSets (list) --
Collection of requested matchmaking rule set objects.
(dict) --
Set of rule statements, used with FlexMatch, that determine how to build a certain kind of player match. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.
A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch Rule Set .
RuleSetName (string) --
Unique identifier for a matchmaking rule set
RuleSetBody (string) --
Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
NextToken (string) --
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.
Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
Available in Amazon GameLift Local.
See also: AWS API Documentation
Request Syntax
response = client.describe_player_sessions(
GameSessionId='string',
PlayerId='string',
PlayerSessionId='string',
PlayerSessionStatusFilter='string',
Limit=123,
NextToken='string'
)
Player session status to filter results on.
Possible player session statuses include the following:
dict
Response Syntax
{
'PlayerSessions': [
{
'PlayerSessionId': 'string',
'PlayerId': 'string',
'GameSessionId': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'RESERVED'|'ACTIVE'|'COMPLETED'|'TIMEDOUT',
'IpAddress': 'string',
'Port': 123,
'PlayerData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
PlayerSessions (list) --
Collection of objects containing properties for each player session that matches the request.
(dict) --
Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED ) or actual player activity in a game session (status ACTIVE ). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.
When a player disconnects, the player session status changes to COMPLETED . Once the session ends, the player session object is retained for 30 days and then removed.
PlayerSessionId (string) --
Unique identifier for a player session.
PlayerId (string) --
Unique identifier for a player that is associated with this player session.
GameSessionId (string) --
Unique identifier for the game session that the player session is connected to.
FleetId (string) --
Unique identifier for a fleet that the player's game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the player session.
Possible player session statuses include the following:
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
PlayerData (string) --
Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
NextToken (string) --
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.
Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.
See also: AWS API Documentation
Request Syntax
response = client.describe_runtime_configuration(
FleetId='string'
)
[REQUIRED]
Unique identifier for a fleet to get the run-time configuration for.
{
'RuntimeConfiguration': {
'ServerProcesses': [
{
'LaunchPath': 'string',
'Parameters': 'string',
'ConcurrentExecutions': 123
},
],
'MaxConcurrentGameSessionActivations': 123,
'GameSessionActivationTimeoutSeconds': 123
}
}
Response Structure
Represents the returned data in response to a request action.
Instructions describing how server processes should be launched and maintained on each instance in the fleet.
Collection of server process configurations that describe which server processes to run on each instance in a fleet.
A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's `` RuntimeConfiguration `` .
Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game , and for Linux instances /local/game . A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe ". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe ".
Optional list of parameters to pass to the server executable on launch.
Number of server processes using this configuration to run concurrently on an instance.
Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING . If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED .
Retrieves all scaling policies applied to a fleet.
To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.
A fleet may have all of its scaling policies suspended ( StopFleetActions ). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.
See also: AWS API Documentation
Request Syntax
response = client.describe_scaling_policies(
FleetId='string',
StatusFilter='ACTIVE'|'UPDATE_REQUESTED'|'UPDATING'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'ERROR',
Limit=123,
NextToken='string'
)
[REQUIRED]
Unique identifier for a fleet to retrieve scaling policies for.
Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.
dict
Response Syntax
{
'ScalingPolicies': [
{
'FleetId': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'UPDATE_REQUESTED'|'UPDATING'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'ERROR',
'ScalingAdjustment': 123,
'ScalingAdjustmentType': 'ChangeInCapacity'|'ExactCapacity'|'PercentChangeInCapacity',
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Threshold': 123.0,
'EvaluationPeriods': 123,
'MetricName': 'ActivatingGameSessions'|'ActiveGameSessions'|'ActiveInstances'|'AvailableGameSessions'|'AvailablePlayerSessions'|'CurrentPlayerSessions'|'IdleInstances'|'PercentAvailableGameSessions'|'PercentIdleInstances'|'QueueDepth'|'WaitTime',
'PolicyType': 'RuleBased'|'TargetBased',
'TargetConfiguration': {
'TargetValue': 123.0
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
ScalingPolicies (list) --
Collection of objects containing the scaling policies matching the request.
(dict) --
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
FleetId (string) --
Unique identifier for a fleet that is associated with this scaling policy.
Name (string) --
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Status (string) --
Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions ; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity .
ScalingAdjustment (integer) --
Amount of adjustment to make, based on the scaling adjustment type.
ScalingAdjustmentType (string) --
Type of adjustment to make to a fleet's instance count (see FleetCapacity ):
ComparisonOperator (string) --
Comparison operator to use when measuring a metric against the threshold value.
Threshold (float) --
Metric value used to trigger a scaling event.
EvaluationPeriods (integer) --
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
MetricName (string) --
Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch .
PolicyType (string) --
Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration . For a rule-based policy set the following parameters: MetricName , ComparisonOperator , Threshold , EvaluationPeriods , ScalingAdjustmentType , and ScalingAdjustment .
TargetConfiguration (dict) --
Object that contains settings for a target-based scaling policy.
TargetValue (float) --
Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
NextToken (string) --
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.
Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_peering_authorizations()
{
'VpcPeeringAuthorizations': [
{
'GameLiftAwsAccountId': 'string',
'PeerVpcAwsAccountId': 'string',
'PeerVpcId': 'string',
'CreationTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1)
},
]
}
Response Structure
Collection of objects that describe all valid VPC peering operations for the current AWS account.
Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.
Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.
To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_peering_connections(
FleetId='string'
)
{
'VpcPeeringConnections': [
{
'FleetId': 'string',
'IpV4CidrBlock': 'string',
'VpcPeeringConnectionId': 'string',
'Status': {
'Code': 'string',
'Message': 'string'
},
'PeerVpcId': 'string',
'GameLiftVpcId': 'string'
},
]
}
Response Structure
Represents the returned data in response to a request action.
Collection of VPC peering connection records that match the request.
Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.
Unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.
CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.
Unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection .
Object that contains status information about the connection. Status indicates if a connection is pending, successful, or failed.
Code indicating the status of a VPC peering connection.
Additional messaging associated with the connection status.
Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets .
Unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.
Note
See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
See also: AWS API Documentation
Request Syntax
response = client.get_game_session_log_url(
GameSessionId='string'
)
[REQUIRED]
Unique identifier for the game session to get logs for.
{
'PreSignedUrl': 'string'
}
Response Structure
Represents the returned data in response to a request action.
Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.
Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance .
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances . If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.
See also: AWS API Documentation
Request Syntax
response = client.get_instance_access(
FleetId='string',
InstanceId='string'
)
[REQUIRED]
Unique identifier for a fleet that contains the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING , ACTIVE , or ERROR . Fleets with an ERROR status may be accessible for a short time before they are deleted.
[REQUIRED]
Unique identifier for an instance you want to get access to. You can access an instance in any status.
dict
Response Syntax
{
'InstanceAccess': {
'FleetId': 'string',
'InstanceId': 'string',
'IpAddress': 'string',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'Credentials': {
'UserName': 'string',
'Secret': 'string'
}
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
InstanceAccess (dict) --
Object that contains connection information for a fleet instance, including IP address and access credentials.
FleetId (string) --
Unique identifier for a fleet containing the instance being accessed.
InstanceId (string) --
Unique identifier for an instance being accessed.
IpAddress (string) --
IP address assigned to the instance.
OperatingSystem (string) --
Operating system that is running on the instance.
Credentials (dict) --
Credentials required to access the instance.
UserName (string) --
User login string.
Secret (string) --
Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it is a private key (which must be saved as a .pem file) for use with SSH.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Note
Returned aliases are not listed in any particular order.
See also: AWS API Documentation
Request Syntax
response = client.list_aliases(
RoutingStrategyType='SIMPLE'|'TERMINAL',
Name='string',
Limit=123,
NextToken='string'
)
Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
dict
Response Syntax
{
'Aliases': [
{
'AliasId': 'string',
'Name': 'string',
'AliasArn': 'string',
'Description': 'string',
'RoutingStrategy': {
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Aliases (list) --
Collection of alias records that match the list request.
(dict) --
Properties describing a fleet alias.
AliasId (string) --
Unique identifier for an alias; alias IDs are unique within a region.
Name (string) --
Descriptive label that is associated with an alias. Alias names do not need to be unique.
AliasArn (string) --
Unique identifier for an alias; alias ARNs are unique across all regions.
Description (string) --
Human-readable description of an alias.
RoutingStrategy (dict) --
Alias configuration for the alias, including routing type and settings.
Type (string) --
Type of routing strategy.
Possible routing types include the following:
FleetId (string) --
Unique identifier for a fleet that the alias points to.
Message (string) --
Message text to be used with a terminal routing strategy.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
LastUpdatedTime (datetime) --
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
NextToken (string) --
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.
Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Note
Build records are not listed in any particular order.
See also: AWS API Documentation
Request Syntax
response = client.list_builds(
Status='INITIALIZED'|'READY'|'FAILED',
Limit=123,
NextToken='string'
)
Build status to filter results by. To retrieve all builds, leave this parameter empty.
Possible build statuses include the following:
dict
Response Syntax
{
'Builds': [
{
'BuildId': 'string',
'Name': 'string',
'Version': 'string',
'Status': 'INITIALIZED'|'READY'|'FAILED',
'SizeOnDisk': 123,
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Builds (list) --
Collection of build records that match the request.
(dict) --
Properties describing a game build.
BuildId (string) --
Unique identifier for a build.
Name (string) --
Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild .
Version (string) --
Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild .
Status (string) --
Current status of the build.
Possible build statuses include the following:
SizeOnDisk (integer) --
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED , this value is 0.
OperatingSystem (string) --
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
NextToken (string) --
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.
Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Note
Fleet records are not listed in any particular order.
See also: AWS API Documentation
Request Syntax
response = client.list_fleets(
BuildId='string',
Limit=123,
NextToken='string'
)
dict
Response Syntax
{
'FleetIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetIds (list) --
Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes , DescribeFleetCapacity , or DescribeFleetUtilization .
NextToken (string) --
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.
Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.
Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.
You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy .
Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling .
Target-based policy
A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.
For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.
To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
Rule-based policy
A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.
For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."
A policy's rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment] .
To implement the example, the rule statement would look like this:
If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10] .
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
See also: AWS API Documentation
Request Syntax
response = client.put_scaling_policy(
Name='string',
FleetId='string',
ScalingAdjustment=123,
ScalingAdjustmentType='ChangeInCapacity'|'ExactCapacity'|'PercentChangeInCapacity',
Threshold=123.0,
ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
EvaluationPeriods=123,
MetricName='ActivatingGameSessions'|'ActiveGameSessions'|'ActiveInstances'|'AvailableGameSessions'|'AvailablePlayerSessions'|'CurrentPlayerSessions'|'IdleInstances'|'PercentAvailableGameSessions'|'PercentIdleInstances'|'QueueDepth'|'WaitTime',
PolicyType='RuleBased'|'TargetBased',
TargetConfiguration={
'TargetValue': 123.0
}
)
[REQUIRED]
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
[REQUIRED]
Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.
Type of adjustment to make to a fleet's instance count (see FleetCapacity ):
[REQUIRED]
Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch .
Object that contains settings for a target-based scaling policy.
Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Name (string) --
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild .
To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.
See also: AWS API Documentation
Request Syntax
response = client.request_upload_credentials(
BuildId='string'
)
[REQUIRED]
Unique identifier for a build to get credentials for.
{
'UploadCredentials': {
'AccessKeyId': 'string',
'SecretAccessKey': 'string',
'SessionToken': 'string'
},
'StorageLocation': {
'Bucket': 'string',
'Key': 'string',
'RoleArn': 'string'
}
}
Response Structure
Represents the returned data in response to a request action.
AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.
Temporary key allowing access to the Amazon GameLift S3 account.
Temporary secret key allowing access to the Amazon GameLift S3 account.
Token used to associate a specific build ID with the files uploaded using these credentials.
Amazon S3 path and key, identifying where the game build files are stored.
Amazon S3 bucket identifier. This is the name of your S3 bucket.
Name of the zip file containing your build files.
Amazon Resource Name (ARN ) for the access role that allows Amazon GameLift to access your S3 bucket.
Retrieves the fleet ID that a specified alias is currently pointing to.
See also: AWS API Documentation
Request Syntax
response = client.resolve_alias(
AliasId='string'
)
[REQUIRED]
Unique identifier for the alias you want to resolve.
{
'FleetId': 'string'
}
Response Structure
Represents the returned data in response to a request action.
Fleet identifier that is associated with the requested alias.
Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:
Note
Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.
To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.
You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails .
See also: AWS API Documentation
Request Syntax
response = client.search_game_sessions(
FleetId='string',
AliasId='string',
FilterExpression='string',
SortExpression='string',
Limit=123,
NextToken='string'
)
String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.
A filter expression can contain one or multiple conditions. Each condition consists of the following:
To chain multiple conditions in a single expression, use the logical keywords AND , OR , and NOT and parentheses as needed. For example: x AND y AND NOT z , NOT (x OR y) .
Session search evaluates conditions from left to right using the following precedence rules:
For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true" .
Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:
For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC" . Results with a null value for the sort operand are returned at the end of the list.
dict
Response Syntax
{
'GameSessions': [
{
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessions (list) --
Collection of objects containing game session properties for each session matching the request.
(dict) --
Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED .
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
NextToken (string) --
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.
Resumes activity on a fleet that was suspended with StopFleetActions . Currently, this operation is used to restart a fleet's auto-scaling activity.
To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes .
See also: AWS API Documentation
Request Syntax
response = client.start_fleet_actions(
FleetId='string',
Actions=[
'AUTO_SCALING',
]
)
[REQUIRED]
Unique identifier for a fleet
[REQUIRED]
List of actions to restart on the fleet.
dict
Response Syntax
{}
Response Structure
Places a request for a new game session in a queue (see CreateGameSessionQueue ). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.
A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.
When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.
Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players.
To place a new game session request, specify the following:
If successful, a new game session placement is created.
To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED , a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.
See also: AWS API Documentation
Request Syntax
response = client.start_game_session_placement(
PlacementId='string',
GameSessionQueueName='string',
GameProperties=[
{
'Key': 'string',
'Value': 'string'
},
],
MaximumPlayerSessionCount=123,
GameSessionName='string',
PlayerLatencies=[
{
'PlayerId': 'string',
'RegionIdentifier': 'string',
'LatencyInMilliseconds': ...
},
],
DesiredPlayerSessions=[
{
'PlayerId': 'string',
'PlayerData': 'string'
},
],
GameSessionData='string'
)
[REQUIRED]
Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.
[REQUIRED]
Name of the queue to use to place the new game session.
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Game property identifier.
Game property value.
[REQUIRED]
Maximum number of players that can be connected simultaneously to the game session.
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.
Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement . This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.
Unique identifier for a player associated with the latency data.
Name of the region that is associated with the latency value.
Amount of time that represents the time lag experienced by the player when connected to the specified region.
Set of information on each player to create a player session for.
Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement .
Unique identifier for a player to associate with the player session.
Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
dict
Response Syntax
{
'GameSessionPlacement': {
'PlacementId': 'string',
'GameSessionQueueName': 'string',
'Status': 'PENDING'|'FULFILLED'|'CANCELLED'|'TIMED_OUT',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'MaximumPlayerSessionCount': 123,
'GameSessionName': 'string',
'GameSessionId': 'string',
'GameSessionArn': 'string',
'GameSessionRegion': 'string',
'PlayerLatencies': [
{
'PlayerId': 'string',
'RegionIdentifier': 'string',
'LatencyInMilliseconds': ...
},
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'IpAddress': 'string',
'Port': 123,
'PlacedPlayerSessions': [
{
'PlayerId': 'string',
'PlayerSessionId': 'string'
},
],
'GameSessionData': 'string',
'MatchmakerData': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionPlacement (dict) --
Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.
PlacementId (string) --
Unique identifier for a game session placement.
GameSessionQueueName (string) --
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
Status (string) --
Current status of the game session placement request.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
GameSessionName (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
GameSessionId (string) --
Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED ).
GameSessionArn (string) --
Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED ). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.
GameSessionRegion (string) --
Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED ).
PlayerLatencies (list) --
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
(dict) --
Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement . This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.
PlayerId (string) --
Unique identifier for a player associated with the latency data.
RegionIdentifier (string) --
Name of the region that is associated with the latency value.
LatencyInMilliseconds (float) --
Amount of time that represents the time lag experienced by the player when connected to the specified region.
StartTime (datetime) --
Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
EndTime (datetime) --
Time stamp indicating when this request was completed, canceled, or timed out.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED ).
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED ).
PlacedPlayerSessions (list) --
Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED ). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
(dict) --
Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
PlayerId (string) --
Unique identifier for a player that is associated with this player session.
PlayerSessionId (string) --
Unique identifier for a player session.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data .
Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.
To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch .
The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works .
See also: AWS API Documentation
Request Syntax
response = client.start_match_backfill(
TicketId='string',
ConfigurationName='string',
GameSessionArn='string',
Players=[
{
'PlayerId': 'string',
'PlayerAttributes': {
'string': {
'S': 'string',
'N': 123.0,
'SL': [
'string',
],
'SDM': {
'string': 123.0
}
}
},
'Team': 'string',
'LatencyInMs': {
'string': 123
}
},
]
)
[REQUIRED]
Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is "MM-4v4".) Use only the name for this parameter.
[REQUIRED]
Amazon Resource Name (ARN ) that is assigned to a game session and uniquely identifies it.
[REQUIRED]
Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.
Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.
Unique identifier for a player
Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}} .
Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.
For single string values. Maximum string length is 100 characters.
For number values, expressed as double.
For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
dict
Response Syntax
{
'MatchmakingTicket': {
'TicketId': 'string',
'ConfigurationName': 'string',
'Status': 'CANCELLED'|'COMPLETED'|'FAILED'|'PLACING'|'QUEUED'|'REQUIRES_ACCEPTANCE'|'SEARCHING'|'TIMED_OUT',
'StatusReason': 'string',
'StatusMessage': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Players': [
{
'PlayerId': 'string',
'PlayerAttributes': {
'string': {
'S': 'string',
'N': 123.0,
'SL': [
'string',
],
'SDM': {
'string': 123.0
}
}
},
'Team': 'string',
'LatencyInMs': {
'string': 123
}
},
],
'GameSessionConnectionInfo': {
'GameSessionArn': 'string',
'IpAddress': 'string',
'Port': 123,
'MatchedPlayerSessions': [
{
'PlayerId': 'string',
'PlayerSessionId': 'string'
},
]
},
'EstimatedWaitTime': 123
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
MatchmakingTicket (dict) --
Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.
TicketId (string) --
Unique identifier for a matchmaking ticket.
ConfigurationName (string) --
Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
Status (string) --
Current status of the matchmaking request.
Note
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
StatusReason (string) --
Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.
StatusMessage (string) --
Additional information about the current status.
StartTime (datetime) --
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
EndTime (datetime) --
Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Players (list) --
A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED , the Player objects include the team the players were assigned to in the resulting match.
(dict) --
Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.
PlayerId (string) --
Unique identifier for a player
PlayerAttributes (dict) --
Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}} .
(string) --
(dict) --
Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.
S (string) --
For single string values. Maximum string length is 100 characters.
N (float) --
For number values, expressed as double.
SL (list) --
For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
SDM (dict) --
For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
Team (string) --
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
LatencyInMs (dict) --
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
GameSessionConnectionInfo (dict) --
Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.
GameSessionArn (string) --
Amazon Resource Name (ARN ) that is assigned to a game session and uniquely identifies it.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
MatchedPlayerSessions (list) --
Collection of player session IDs, one for each player ID that was included in the original matchmaking request.
(dict) --
Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.
When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.
PlayerId (string) --
Unique identifier for a player
PlayerSessionId (string) --
Unique identifier for a player session
EstimatedWaitTime (integer) --
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration . For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game .
To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED . Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches.
Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests:
Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows:
See also: AWS API Documentation
Request Syntax
response = client.start_matchmaking(
TicketId='string',
ConfigurationName='string',
Players=[
{
'PlayerId': 'string',
'PlayerAttributes': {
'string': {
'S': 'string',
'N': 123.0,
'SL': [
'string',
],
'SDM': {
'string': 123.0
}
}
},
'Team': 'string',
'LatencyInMs': {
'string': 123
}
},
]
)
[REQUIRED]
Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.
[REQUIRED]
Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.
Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.
Unique identifier for a player
Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}} .
Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.
For single string values. Maximum string length is 100 characters.
For number values, expressed as double.
For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
dict
Response Syntax
{
'MatchmakingTicket': {
'TicketId': 'string',
'ConfigurationName': 'string',
'Status': 'CANCELLED'|'COMPLETED'|'FAILED'|'PLACING'|'QUEUED'|'REQUIRES_ACCEPTANCE'|'SEARCHING'|'TIMED_OUT',
'StatusReason': 'string',
'StatusMessage': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'Players': [
{
'PlayerId': 'string',
'PlayerAttributes': {
'string': {
'S': 'string',
'N': 123.0,
'SL': [
'string',
],
'SDM': {
'string': 123.0
}
}
},
'Team': 'string',
'LatencyInMs': {
'string': 123
}
},
],
'GameSessionConnectionInfo': {
'GameSessionArn': 'string',
'IpAddress': 'string',
'Port': 123,
'MatchedPlayerSessions': [
{
'PlayerId': 'string',
'PlayerSessionId': 'string'
},
]
},
'EstimatedWaitTime': 123
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
MatchmakingTicket (dict) --
Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.
TicketId (string) --
Unique identifier for a matchmaking ticket.
ConfigurationName (string) --
Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.
Status (string) --
Current status of the matchmaking request.
Note
Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
StatusReason (string) --
Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.
StatusMessage (string) --
Additional information about the current status.
StartTime (datetime) --
Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
EndTime (datetime) --
Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Players (list) --
A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED , the Player objects include the team the players were assigned to in the resulting match.
(dict) --
Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.
PlayerId (string) --
Unique identifier for a player
PlayerAttributes (dict) --
Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}} .
(string) --
(dict) --
Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. Each AttributeValue object can use only one of the available properties.
S (string) --
For single string values. Maximum string length is 100 characters.
N (float) --
For number values, expressed as double.
SL (list) --
For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
SDM (dict) --
For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
Team (string) --
Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
LatencyInMs (dict) --
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.
If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.
GameSessionConnectionInfo (dict) --
Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.
GameSessionArn (string) --
Amazon Resource Name (ARN ) that is assigned to a game session and uniquely identifies it.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
MatchedPlayerSessions (list) --
Collection of player session IDs, one for each player ID that was included in the original matchmaking request.
(dict) --
Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.
When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.
PlayerId (string) --
Unique identifier for a player
PlayerSessionId (string) --
Unique identifier for a player session
EstimatedWaitTime (integer) --
Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.
Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions . You can view a fleet's stopped actions using DescribeFleetAttributes .
To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting ( FleetCapacity . Changes to the fleet's capacity must be done manually using UpdateFleetCapacity .
See also: AWS API Documentation
Request Syntax
response = client.stop_fleet_actions(
FleetId='string',
Actions=[
'AUTO_SCALING',
]
)
[REQUIRED]
Unique identifier for a fleet
[REQUIRED]
List of actions to suspend on the fleet.
dict
Response Syntax
{}
Response Structure
Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.
See also: AWS API Documentation
Request Syntax
response = client.stop_game_session_placement(
PlacementId='string'
)
[REQUIRED]
Unique identifier for a game session placement to cancel.
{
'GameSessionPlacement': {
'PlacementId': 'string',
'GameSessionQueueName': 'string',
'Status': 'PENDING'|'FULFILLED'|'CANCELLED'|'TIMED_OUT',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'MaximumPlayerSessionCount': 123,
'GameSessionName': 'string',
'GameSessionId': 'string',
'GameSessionArn': 'string',
'GameSessionRegion': 'string',
'PlayerLatencies': [
{
'PlayerId': 'string',
'RegionIdentifier': 'string',
'LatencyInMilliseconds': ...
},
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'IpAddress': 'string',
'Port': 123,
'PlacedPlayerSessions': [
{
'PlayerId': 'string',
'PlayerSessionId': 'string'
},
],
'GameSessionData': 'string',
'MatchmakerData': 'string'
}
}
Response Structure
Represents the returned data in response to a request action.
Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.
Unique identifier for a game session placement.
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
Current status of the game session placement request.
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Game property identifier.
Game property value.
Maximum number of players that can be connected simultaneously to the game session.
Descriptive label that is associated with a game session. Session names do not need to be unique.
Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED ).
Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED ). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.
Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED ).
Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.
Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement . This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.
Unique identifier for a player associated with the latency data.
Name of the region that is associated with the latency value.
Amount of time that represents the time lag experienced by the player when connected to the specified region.
Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Time stamp indicating when this request was completed, canceled, or timed out.
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED ).
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED ).
Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED ). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.
Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
Unique identifier for a player that is associated with this player session.
Unique identifier for a player session.
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data .
Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED .
See also: AWS API Documentation
Request Syntax
response = client.stop_matchmaking(
TicketId='string'
)
[REQUIRED]
Unique identifier for a matchmaking ticket.
{}
Response Structure
Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
See also: AWS API Documentation
Request Syntax
response = client.update_alias(
AliasId='string',
Name='string',
Description='string',
RoutingStrategy={
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
}
)
[REQUIRED]
Unique identifier for a fleet alias. Specify the alias you want to update.
Object that specifies the fleet and routing type to use for the alias.
Type of routing strategy.
Possible routing types include the following:
Unique identifier for a fleet that the alias points to.
Message text to be used with a terminal routing strategy.
dict
Response Syntax
{
'Alias': {
'AliasId': 'string',
'Name': 'string',
'AliasArn': 'string',
'Description': 'string',
'RoutingStrategy': {
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Alias (dict) --
Object that contains the updated alias configuration.
AliasId (string) --
Unique identifier for an alias; alias IDs are unique within a region.
Name (string) --
Descriptive label that is associated with an alias. Alias names do not need to be unique.
AliasArn (string) --
Unique identifier for an alias; alias ARNs are unique across all regions.
Description (string) --
Human-readable description of an alias.
RoutingStrategy (dict) --
Alias configuration for the alias, including routing type and settings.
Type (string) --
Type of routing strategy.
Possible routing types include the following:
FleetId (string) --
Unique identifier for a fleet that the alias points to.
Message (string) --
Message text to be used with a terminal routing strategy.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
LastUpdatedTime (datetime) --
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
See also: AWS API Documentation
Request Syntax
response = client.update_build(
BuildId='string',
Name='string',
Version='string'
)
[REQUIRED]
Unique identifier for a build to update.
dict
Response Syntax
{
'Build': {
'BuildId': 'string',
'Name': 'string',
'Version': 'string',
'Status': 'INITIALIZED'|'READY'|'FAILED',
'SizeOnDisk': 123,
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'CreationTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Build (dict) --
Object that contains the updated build record.
BuildId (string) --
Unique identifier for a build.
Name (string) --
Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild .
Version (string) --
Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild .
Status (string) --
Current status of the build.
Possible build statuses include the following:
SizeOnDisk (integer) --
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED , this value is 0.
OperatingSystem (string) --
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.
See also: AWS API Documentation
Request Syntax
response = client.update_fleet_attributes(
FleetId='string',
Name='string',
Description='string',
NewGameSessionProtectionPolicy='NoProtection'|'FullProtection',
ResourceCreationLimitPolicy={
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
MetricGroups=[
'string',
]
)
[REQUIRED]
Unique identifier for a fleet to update attribute metadata for.
Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession .
Policy that limits the number of game sessions an individual player can create over a span of time.
Maximum number of game sessions that an individual can create during the policy period.
Time span used in evaluating the resource creation limit policy.
Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.
dict
Response Syntax
{
'FleetId': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetId (string) --
Unique identifier for a fleet that was updated.
Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy ) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity . If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs.
See also: AWS API Documentation
Request Syntax
response = client.update_fleet_capacity(
FleetId='string',
DesiredInstances=123,
MinSize=123,
MaxSize=123
)
[REQUIRED]
Unique identifier for a fleet to update capacity for.
dict
Response Syntax
{
'FleetId': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetId (string) --
Unique identifier for a fleet that was updated.
Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations , and permissions you want to remove in InboundPermissionRevocations . Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.
See also: AWS API Documentation
Request Syntax
response = client.update_fleet_port_settings(
FleetId='string',
InboundPermissionAuthorizations=[
{
'FromPort': 123,
'ToPort': 123,
'IpRange': 'string',
'Protocol': 'TCP'|'UDP'
},
],
InboundPermissionRevocations=[
{
'FromPort': 123,
'ToPort': 123,
'IpRange': 'string',
'Protocol': 'TCP'|'UDP'
},
]
)
[REQUIRED]
Unique identifier for a fleet to update port settings for.
Collection of port settings to be added to the fleet record.
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.
Starting value for a range of allowed port numbers.
Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort .
Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask] " or optionally the shortened version "0.0.0.0/[subnet mask] ".
Network communication protocol used by the fleet.
Collection of port settings to be removed from the fleet record.
A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.
Starting value for a range of allowed port numbers.
Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort .
Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask] " or optionally the shortened version "0.0.0.0/[subnet mask] ".
Network communication protocol used by the fleet.
dict
Response Syntax
{
'FleetId': 'string'
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetId (string) --
Unique identifier for a fleet that was updated.
Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
See also: AWS API Documentation
Request Syntax
response = client.update_game_session(
GameSessionId='string',
MaximumPlayerSessionCount=123,
Name='string',
PlayerSessionCreationPolicy='ACCEPT_ALL'|'DENY_ALL',
ProtectionPolicy='NoProtection'|'FullProtection'
)
[REQUIRED]
Unique identifier for the game session to update.
Game session protection policy to apply to this game session only.
dict
Response Syntax
{
'GameSession': {
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSession (dict) --
Object that contains the updated game session metadata.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
See also: AWS API Documentation
Request Syntax
response = client.update_game_session_queue(
Name='string',
TimeoutInSeconds=123,
PlayerLatencyPolicies=[
{
'MaximumIndividualPlayerLatencyMilliseconds': 123,
'PolicyDurationSeconds': 123
},
],
Destinations=[
{
'DestinationArn': 'string'
},
]
)
[REQUIRED]
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.
Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.
dict
Response Syntax
{
'GameSessionQueue': {
'Name': 'string',
'GameSessionQueueArn': 'string',
'TimeoutInSeconds': 123,
'PlayerLatencyPolicies': [
{
'MaximumIndividualPlayerLatencyMilliseconds': 123,
'PolicyDurationSeconds': 123
},
],
'Destinations': [
{
'DestinationArn': 'string'
},
]
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionQueue (dict) --
Object that describes the newly updated game session queue.
Name (string) --
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
GameSessionQueueArn (string) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
TimeoutInSeconds (integer) --
Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
PlayerLatencyPolicies (list) --
Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
(dict) --
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
MaximumIndividualPlayerLatencyMilliseconds (integer) --
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
PolicyDurationSeconds (integer) --
The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
Destinations (list) --
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
(dict) --
Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
DestinationArn (string) --
Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.
Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.
See also: AWS API Documentation
Request Syntax
response = client.update_matchmaking_configuration(
Name='string',
Description='string',
GameSessionQueueArns=[
'string',
],
RequestTimeoutSeconds=123,
AcceptanceTimeoutSeconds=123,
AcceptanceRequired=True|False,
RuleSetName='string',
NotificationTarget='string',
AdditionalPlayerCount=123,
CustomEventData='string',
GameProperties=[
{
'Key': 'string',
'Value': 'string'
},
],
GameSessionData='string'
)
[REQUIRED]
Unique identifier for a matchmaking configuration to update.
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Game property identifier.
Game property value.
dict
Response Syntax
{
'Configuration': {
'Name': 'string',
'Description': 'string',
'GameSessionQueueArns': [
'string',
],
'RequestTimeoutSeconds': 123,
'AcceptanceTimeoutSeconds': 123,
'AcceptanceRequired': True|False,
'RuleSetName': 'string',
'NotificationTarget': 'string',
'AdditionalPlayerCount': 123,
'CustomEventData': 'string',
'CreationTime': datetime(2015, 1, 1),
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'GameSessionData': 'string'
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Configuration (dict) --
Object that describes the updated matchmaking configuration.
Name (string) --
Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
Description (string) --
Descriptive label that is associated with matchmaking configuration.
GameSessionQueueArns (list) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
RequestTimeoutSeconds (integer) --
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
AcceptanceTimeoutSeconds (integer) --
Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
AcceptanceRequired (boolean) --
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
RuleSetName (string) --
Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.
NotificationTarget (string) --
SNS topic ARN that is set up to receive matchmaking notifications.
AdditionalPlayerCount (integer) --
Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
CustomEventData (string) --
Information to attached to all events related to the matchmaking configuration.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.
To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.
Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.
See also: AWS API Documentation
Request Syntax
response = client.update_runtime_configuration(
FleetId='string',
RuntimeConfiguration={
'ServerProcesses': [
{
'LaunchPath': 'string',
'Parameters': 'string',
'ConcurrentExecutions': 123
},
],
'MaxConcurrentGameSessionActivations': 123,
'GameSessionActivationTimeoutSeconds': 123
}
)
[REQUIRED]
Unique identifier for a fleet to update run-time configuration for.
[REQUIRED]
Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.
Collection of server process configurations that describe which server processes to run on each instance in a fleet.
A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's `` RuntimeConfiguration `` .
Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game , and for Linux instances /local/game . A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe ". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe ".
Optional list of parameters to pass to the server executable on launch.
Number of server processes using this configuration to run concurrently on an instance.
Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING . If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED .
dict
Response Syntax
{
'RuntimeConfiguration': {
'ServerProcesses': [
{
'LaunchPath': 'string',
'Parameters': 'string',
'ConcurrentExecutions': 123
},
],
'MaxConcurrentGameSessionActivations': 123,
'GameSessionActivationTimeoutSeconds': 123
}
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
RuntimeConfiguration (dict) --
The run-time configuration currently in force. If the update was successful, this object matches the one in the request.
ServerProcesses (list) --
Collection of server process configurations that describe which server processes to run on each instance in a fleet.
(dict) --
A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's `` RuntimeConfiguration `` .
LaunchPath (string) --
Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game , and for Linux instances /local/game . A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe ". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe ".
Parameters (string) --
Optional list of parameters to pass to the server executable on launch.
ConcurrentExecutions (integer) --
Number of server processes using this configuration to run concurrently on an instance.
MaxConcurrentGameSessionActivations (integer) --
Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.
GameSessionActivationTimeoutSeconds (integer) --
Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING . If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED .
Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.
Learn more
Related operations
See also: AWS API Documentation
Request Syntax
response = client.validate_matchmaking_rule_set(
RuleSetBody='string'
)
[REQUIRED]
Collection of matchmaking rules to validate, formatted as a JSON string.
{
'Valid': True|False
}
Response Structure
Represents the returned data in response to a request action.
Response indicating whether or not the rule set is valid.
The available paginators are:
paginator = client.get_paginator('describe_fleet_attributes')
Creates an iterator that will paginate through responses from GameLift.Client.describe_fleet_attributes().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Unique identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FleetAttributes': [
{
'FleetId': 'string',
'FleetArn': 'string',
'FleetType': 'ON_DEMAND'|'SPOT',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'Description': 'string',
'Name': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED',
'BuildId': 'string',
'ServerLaunchPath': 'string',
'ServerLaunchParameters': 'string',
'LogPaths': [
'string',
],
'NewGameSessionProtectionPolicy': 'NoProtection'|'FullProtection',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'ResourceCreationLimitPolicy': {
'NewGameSessionsPerCreator': 123,
'PolicyPeriodInMinutes': 123
},
'MetricGroups': [
'string',
],
'StoppedActions': [
'AUTO_SCALING',
]
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetAttributes (list) --
Collection of objects containing attribute metadata for each requested fleet ID.
(dict) --
General properties describing a fleet.
FleetId (string) --
Unique identifier for a fleet.
FleetArn (string) --
Identifier for a fleet that is unique across all regions.
FleetType (string) --
Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.
InstanceType (string) --
EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.
Description (string) --
Human-readable description of the fleet.
Name (string) --
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the fleet.
Possible fleet statuses include the following:
BuildId (string) --
Unique identifier for a build.
ServerLaunchPath (string) --
Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration .
ServerLaunchParameters (string) --
Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration .
LogPaths (list) --
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide . If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
NewGameSessionProtectionPolicy (string) --
Type of game session protection to set for all new instances started in the fleet.
OperatingSystem (string) --
Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
ResourceCreationLimitPolicy (dict) --
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
NewGameSessionsPerCreator (integer) --
Maximum number of game sessions that an individual can create during the policy period.
PolicyPeriodInMinutes (integer) --
Time span used in evaluating the resource creation limit policy.
MetricGroups (list) --
Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.
StoppedActions (list) --
List of fleet actions that have been suspended using StopFleetActions . This includes auto-scaling.
paginator = client.get_paginator('describe_fleet_capacity')
Creates an iterator that will paginate through responses from GameLift.Client.describe_fleet_capacity().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FleetCapacity': [
{
'FleetId': 'string',
'InstanceType': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'InstanceCounts': {
'DESIRED': 123,
'MINIMUM': 123,
'MAXIMUM': 123,
'PENDING': 123,
'ACTIVE': 123,
'IDLE': 123,
'TERMINATING': 123
}
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetCapacity (list) --
Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
(dict) --
Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.
FleetId (string) --
Unique identifier for a fleet.
InstanceType (string) --
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
InstanceCounts (dict) --
Current status of fleet capacity.
DESIRED (integer) --
Ideal number of active instances in the fleet.
MINIMUM (integer) --
Minimum value allowed for the fleet's instance count.
MAXIMUM (integer) --
Maximum value allowed for the fleet's instance count.
PENDING (integer) --
Number of instances in the fleet that are starting but not yet active.
ACTIVE (integer) --
Actual number of active instances in the fleet.
IDLE (integer) --
Number of active instances in the fleet that are not currently hosting a game session.
TERMINATING (integer) --
Number of instances in the fleet that are no longer active but haven't yet been terminated.
paginator = client.get_paginator('describe_fleet_events')
Creates an iterator that will paginate through responses from GameLift.Client.describe_fleet_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Unique identifier for a fleet to get event logs for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Events': [
{
'EventId': 'string',
'ResourceId': 'string',
'EventCode': 'GENERIC_EVENT'|'FLEET_CREATED'|'FLEET_DELETED'|'FLEET_SCALING_EVENT'|'FLEET_STATE_DOWNLOADING'|'FLEET_STATE_VALIDATING'|'FLEET_STATE_BUILDING'|'FLEET_STATE_ACTIVATING'|'FLEET_STATE_ACTIVE'|'FLEET_STATE_ERROR'|'FLEET_INITIALIZATION_FAILED'|'FLEET_BINARY_DOWNLOAD_FAILED'|'FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND'|'FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE'|'FLEET_VALIDATION_TIMED_OUT'|'FLEET_ACTIVATION_FAILED'|'FLEET_ACTIVATION_FAILED_NO_INSTANCES'|'FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED'|'SERVER_PROCESS_INVALID_PATH'|'SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT'|'SERVER_PROCESS_PROCESS_READY_TIMEOUT'|'SERVER_PROCESS_CRASHED'|'SERVER_PROCESS_TERMINATED_UNHEALTHY'|'SERVER_PROCESS_FORCE_TERMINATED'|'SERVER_PROCESS_PROCESS_EXIT_TIMEOUT'|'GAME_SESSION_ACTIVATION_TIMEOUT'|'FLEET_CREATION_EXTRACTING_BUILD'|'FLEET_CREATION_RUNNING_INSTALLER'|'FLEET_CREATION_VALIDATING_RUNTIME_CONFIG'|'FLEET_VPC_PEERING_SUCCEEDED'|'FLEET_VPC_PEERING_FAILED'|'FLEET_VPC_PEERING_DELETED'|'INSTANCE_INTERRUPTED',
'Message': 'string',
'EventTime': datetime(2015, 1, 1),
'PreSignedLogUrl': 'string'
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Events (list) --
Collection of objects containing event log entries for the specified fleet.
(dict) --
Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.
EventId (string) --
Unique identifier for a fleet event.
ResourceId (string) --
Unique identifier for an event resource, such as a fleet ID.
EventCode (string) --
Type of event being logged. The following events are currently in use:
Fleet creation events:
VPC peering events:
Spot instance events:
Other fleet events:
Message (string) --
Additional information related to the event.
EventTime (datetime) --
Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
PreSignedLogUrl (string) --
Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.
paginator = client.get_paginator('describe_fleet_utilization')
Creates an iterator that will paginate through responses from GameLift.Client.describe_fleet_utilization().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FleetUtilization': [
{
'FleetId': 'string',
'ActiveServerProcessCount': 123,
'ActiveGameSessionCount': 123,
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetUtilization (list) --
Collection of objects containing utilization information for each requested fleet ID.
(dict) --
Current status of fleet utilization, including the number of game and player sessions being hosted.
FleetId (string) --
Unique identifier for a fleet.
ActiveServerProcessCount (integer) --
Number of server processes in an ACTIVE status currently running across all instances in the fleet
ActiveGameSessionCount (integer) --
Number of active game sessions currently being hosted on all instances in the fleet.
CurrentPlayerSessionCount (integer) --
Number of active player sessions currently being hosted on all instances in the fleet.
MaximumPlayerSessionCount (integer) --
Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.
paginator = client.get_paginator('describe_game_session_details')
Creates an iterator that will paginate through responses from GameLift.Client.describe_game_session_details().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetId='string',
GameSessionId='string',
AliasId='string',
StatusFilter='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GameSessionDetails': [
{
'GameSession': {
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
},
'ProtectionPolicy': 'NoProtection'|'FullProtection'
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionDetails (list) --
Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
(dict) --
A game session's properties plus the protection policy currently in force.
GameSession (dict) --
Object that describes a game session.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
ProtectionPolicy (string) --
Current status of protection for the game session.
paginator = client.get_paginator('describe_game_session_queues')
Creates an iterator that will paginate through responses from GameLift.Client.describe_game_session_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GameSessionQueues': [
{
'Name': 'string',
'GameSessionQueueArn': 'string',
'TimeoutInSeconds': 123,
'PlayerLatencyPolicies': [
{
'MaximumIndividualPlayerLatencyMilliseconds': 123,
'PolicyDurationSeconds': 123
},
],
'Destinations': [
{
'DestinationArn': 'string'
},
]
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessionQueues (list) --
Collection of objects that describes the requested game session queues.
(dict) --
Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
Name (string) --
Descriptive label that is associated with game session queue. Queue names must be unique within each region.
GameSessionQueueArn (string) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
TimeoutInSeconds (integer) --
Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
PlayerLatencyPolicies (list) --
Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.
(dict) --
Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
MaximumIndividualPlayerLatencyMilliseconds (integer) --
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
PolicyDurationSeconds (integer) --
The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.
Destinations (list) --
List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
(dict) --
Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
DestinationArn (string) --
Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.
paginator = client.get_paginator('describe_game_sessions')
Creates an iterator that will paginate through responses from GameLift.Client.describe_game_sessions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetId='string',
GameSessionId='string',
AliasId='string',
StatusFilter='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GameSessions': [
{
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessions (list) --
Collection of objects containing game session properties for each session matching the request.
(dict) --
Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED .
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).
paginator = client.get_paginator('describe_instances')
Creates an iterator that will paginate through responses from GameLift.Client.describe_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetId='string',
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Unique identifier for a fleet to retrieve instance information for.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Instances': [
{
'FleetId': 'string',
'InstanceId': 'string',
'IpAddress': 'string',
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge',
'Status': 'PENDING'|'ACTIVE'|'TERMINATING',
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Instances (list) --
Collection of objects containing properties for each instance returned.
(dict) --
Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.
FleetId (string) --
Unique identifier for a fleet that the instance is in.
InstanceId (string) --
Unique identifier for an instance.
IpAddress (string) --
IP address assigned to the instance.
OperatingSystem (string) --
Operating system that is running on this instance.
Type (string) --
EC2 instance type that defines the computing resources of this instance.
Status (string) --
Current status of the instance. Possible statuses include the following:
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
paginator = client.get_paginator('describe_matchmaking_configurations')
Creates an iterator that will paginate through responses from GameLift.Client.describe_matchmaking_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
RuleSetName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Configurations': [
{
'Name': 'string',
'Description': 'string',
'GameSessionQueueArns': [
'string',
],
'RequestTimeoutSeconds': 123,
'AcceptanceTimeoutSeconds': 123,
'AcceptanceRequired': True|False,
'RuleSetName': 'string',
'NotificationTarget': 'string',
'AdditionalPlayerCount': 123,
'CustomEventData': 'string',
'CreationTime': datetime(2015, 1, 1),
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'GameSessionData': 'string'
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Configurations (list) --
Collection of requested matchmaking configuration objects.
(dict) --
Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.
Name (string) --
Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
Description (string) --
Descriptive label that is associated with matchmaking configuration.
GameSessionQueueArns (list) --
Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
RequestTimeoutSeconds (integer) --
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
AcceptanceTimeoutSeconds (integer) --
Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
AcceptanceRequired (boolean) --
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
RuleSetName (string) --
Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.
NotificationTarget (string) --
SNS topic ARN that is set up to receive matchmaking notifications.
AdditionalPlayerCount (integer) --
Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
CustomEventData (string) --
Information to attached to all events related to the matchmaking configuration.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
paginator = client.get_paginator('describe_matchmaking_rule_sets')
Creates an iterator that will paginate through responses from GameLift.Client.describe_matchmaking_rule_sets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Names=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
List of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RuleSets': [
{
'RuleSetName': 'string',
'RuleSetBody': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
RuleSets (list) --
Collection of requested matchmaking rule set objects.
(dict) --
Set of rule statements, used with FlexMatch, that determine how to build a certain kind of player match. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.
A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch Rule Set .
RuleSetName (string) --
Unique identifier for a matchmaking rule set
RuleSetBody (string) --
Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
paginator = client.get_paginator('describe_player_sessions')
Creates an iterator that will paginate through responses from GameLift.Client.describe_player_sessions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GameSessionId='string',
PlayerId='string',
PlayerSessionId='string',
PlayerSessionStatusFilter='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Player session status to filter results on.
Possible player session statuses include the following:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PlayerSessions': [
{
'PlayerSessionId': 'string',
'PlayerId': 'string',
'GameSessionId': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'Status': 'RESERVED'|'ACTIVE'|'COMPLETED'|'TIMEDOUT',
'IpAddress': 'string',
'Port': 123,
'PlayerData': 'string'
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
PlayerSessions (list) --
Collection of objects containing properties for each player session that matches the request.
(dict) --
Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED ) or actual player activity in a game session (status ACTIVE ). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.
When a player disconnects, the player session status changes to COMPLETED . Once the session ends, the player session object is retained for 30 days and then removed.
PlayerSessionId (string) --
Unique identifier for a player session.
PlayerId (string) --
Unique identifier for a player that is associated with this player session.
GameSessionId (string) --
Unique identifier for the game session that the player session is connected to.
FleetId (string) --
Unique identifier for a fleet that the player's game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status (string) --
Current status of the player session.
Possible player session statuses include the following:
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.
PlayerData (string) --
Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
paginator = client.get_paginator('describe_scaling_policies')
Creates an iterator that will paginate through responses from GameLift.Client.describe_scaling_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetId='string',
StatusFilter='ACTIVE'|'UPDATE_REQUESTED'|'UPDATING'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'ERROR',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Unique identifier for a fleet to retrieve scaling policies for.
Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ScalingPolicies': [
{
'FleetId': 'string',
'Name': 'string',
'Status': 'ACTIVE'|'UPDATE_REQUESTED'|'UPDATING'|'DELETE_REQUESTED'|'DELETING'|'DELETED'|'ERROR',
'ScalingAdjustment': 123,
'ScalingAdjustmentType': 'ChangeInCapacity'|'ExactCapacity'|'PercentChangeInCapacity',
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'Threshold': 123.0,
'EvaluationPeriods': 123,
'MetricName': 'ActivatingGameSessions'|'ActiveGameSessions'|'ActiveInstances'|'AvailableGameSessions'|'AvailablePlayerSessions'|'CurrentPlayerSessions'|'IdleInstances'|'PercentAvailableGameSessions'|'PercentIdleInstances'|'QueueDepth'|'WaitTime',
'PolicyType': 'RuleBased'|'TargetBased',
'TargetConfiguration': {
'TargetValue': 123.0
}
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
ScalingPolicies (list) --
Collection of objects containing the scaling policies matching the request.
(dict) --
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
FleetId (string) --
Unique identifier for a fleet that is associated with this scaling policy.
Name (string) --
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Status (string) --
Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions ; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity .
ScalingAdjustment (integer) --
Amount of adjustment to make, based on the scaling adjustment type.
ScalingAdjustmentType (string) --
Type of adjustment to make to a fleet's instance count (see FleetCapacity ):
ComparisonOperator (string) --
Comparison operator to use when measuring a metric against the threshold value.
Threshold (float) --
Metric value used to trigger a scaling event.
EvaluationPeriods (integer) --
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
MetricName (string) --
Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch .
PolicyType (string) --
Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration . For a rule-based policy set the following parameters: MetricName , ComparisonOperator , Threshold , EvaluationPeriods , ScalingAdjustmentType , and ScalingAdjustment .
TargetConfiguration (dict) --
Object that contains settings for a target-based scaling policy.
TargetValue (float) --
Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).
paginator = client.get_paginator('list_aliases')
Creates an iterator that will paginate through responses from GameLift.Client.list_aliases().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RoutingStrategyType='SIMPLE'|'TERMINAL',
Name='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.
Possible routing types include the following:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Aliases': [
{
'AliasId': 'string',
'Name': 'string',
'AliasArn': 'string',
'Description': 'string',
'RoutingStrategy': {
'Type': 'SIMPLE'|'TERMINAL',
'FleetId': 'string',
'Message': 'string'
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Aliases (list) --
Collection of alias records that match the list request.
(dict) --
Properties describing a fleet alias.
AliasId (string) --
Unique identifier for an alias; alias IDs are unique within a region.
Name (string) --
Descriptive label that is associated with an alias. Alias names do not need to be unique.
AliasArn (string) --
Unique identifier for an alias; alias ARNs are unique across all regions.
Description (string) --
Human-readable description of an alias.
RoutingStrategy (dict) --
Alias configuration for the alias, including routing type and settings.
Type (string) --
Type of routing strategy.
Possible routing types include the following:
FleetId (string) --
Unique identifier for a fleet that the alias points to.
Message (string) --
Message text to be used with a terminal routing strategy.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
LastUpdatedTime (datetime) --
Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
paginator = client.get_paginator('list_builds')
Creates an iterator that will paginate through responses from GameLift.Client.list_builds().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Status='INITIALIZED'|'READY'|'FAILED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Build status to filter results by. To retrieve all builds, leave this parameter empty.
Possible build statuses include the following:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Builds': [
{
'BuildId': 'string',
'Name': 'string',
'Version': 'string',
'Status': 'INITIALIZED'|'READY'|'FAILED',
'SizeOnDisk': 123,
'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX',
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
Builds (list) --
Collection of build records that match the request.
(dict) --
Properties describing a game build.
BuildId (string) --
Unique identifier for a build.
Name (string) --
Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild .
Version (string) --
Version that is associated with this build. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild .
Status (string) --
Current status of the build.
Possible build statuses include the following:
SizeOnDisk (integer) --
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED , this value is 0.
OperatingSystem (string) --
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
paginator = client.get_paginator('list_fleets')
Creates an iterator that will paginate through responses from GameLift.Client.list_fleets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
BuildId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FleetIds': [
'string',
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
FleetIds (list) --
Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes , DescribeFleetCapacity , or DescribeFleetUtilization .
paginator = client.get_paginator('search_game_sessions')
Creates an iterator that will paginate through responses from GameLift.Client.search_game_sessions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
FleetId='string',
AliasId='string',
FilterExpression='string',
SortExpression='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.
A filter expression can contain one or multiple conditions. Each condition consists of the following:
To chain multiple conditions in a single expression, use the logical keywords AND , OR , and NOT and parentheses as needed. For example: x AND y AND NOT z , NOT (x OR y) .
Session search evaluates conditions from left to right using the following precedence rules:
For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true" .
Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:
For example, this sort expression returns the oldest active sessions first: "SortExpression": "creationTimeMillis ASC" . Results with a null value for the sort operand are returned at the end of the list.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GameSessions': [
{
'GameSessionId': 'string',
'Name': 'string',
'FleetId': 'string',
'CreationTime': datetime(2015, 1, 1),
'TerminationTime': datetime(2015, 1, 1),
'CurrentPlayerSessionCount': 123,
'MaximumPlayerSessionCount': 123,
'Status': 'ACTIVE'|'ACTIVATING'|'TERMINATED'|'TERMINATING'|'ERROR',
'StatusReason': 'INTERRUPTED',
'GameProperties': [
{
'Key': 'string',
'Value': 'string'
},
],
'IpAddress': 'string',
'Port': 123,
'PlayerSessionCreationPolicy': 'ACCEPT_ALL'|'DENY_ALL',
'CreatorId': 'string',
'GameSessionData': 'string',
'MatchmakerData': 'string'
},
],
}
Response Structure
(dict) --
Represents the returned data in response to a request action.
GameSessions (list) --
Collection of objects containing game session properties for each session matching the request.
(dict) --
Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED .
Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
GameSessionId (string) --
Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> .
Name (string) --
Descriptive label that is associated with a game session. Session names do not need to be unique.
FleetId (string) --
Unique identifier for a fleet that the game session is running on.
CreationTime (datetime) --
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime (datetime) --
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
CurrentPlayerSessionCount (integer) --
Number of players currently in the game session.
MaximumPlayerSessionCount (integer) --
Maximum number of players that can be connected simultaneously to the game session.
Status (string) --
Current status of the game session. A game session must have an ACTIVE status to have player sessions.
StatusReason (string) --
Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
GameProperties (list) --
Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ). You can search for active game sessions based on this custom data with SearchGameSessions .
(dict) --
Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide .
Key (string) --
Game property identifier.
Value (string) --
Game property value.
IpAddress (string) --
IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
Port (integer) --
Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.
PlayerSessionCreationPolicy (string) --
Indicates whether or not the game session is accepting new players.
CreatorId (string) --
Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.
GameSessionData (string) --
Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session ).
MatchmakerData (string) --
Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data . Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill ).