[−][src]Crate rusoto_gamelift
Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage.
When setting up hosting resources, you can deploy your custom game server or use the Amazon GameLift Realtime Servers. Realtime Servers gives you the ability to quickly stand up lightweight, efficient game servers with the core Amazon GameLift infrastructure already built in.
Get Amazon GameLift Tools and Resources
This reference guide describes the low-level service API for Amazon GameLift and provides links to language-specific SDK reference topics. See also Amazon GameLift Tools and Resources.
API Summary
The Amazon GameLift service API includes two key sets of actions:
-
Manage game sessions and player access -- Integrate this functionality into game client services in order to create new game sessions, retrieve information on existing game sessions; reserve a player slot in a game session, request matchmaking, etc.
-
Configure and manage game server resources -- Manage your Amazon GameLift hosting resources, including builds, scripts, fleets, queues, and aliases. Set up matchmakers, configure auto-scaling, retrieve game logs, and get hosting and game metrics.
Task-based list of API actions
If you're using the service, you're probably looking for GameLiftClient and GameLift.
Structs
AcceptMatchInput | Represents the input for a request action. |
AcceptMatchOutput | |
Alias | Properties describing a fleet alias. |
AttributeValue | 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 |
AwsCredentials | Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials. |
Build | Properties describing a custom game build. Related operations |
CreateAliasInput | Represents the input for a request action. |
CreateAliasOutput | Represents the returned data in response to a request action. |
CreateBuildInput | Represents the input for a request action. |
CreateBuildOutput | Represents the returned data in response to a request action. |
CreateFleetInput | Represents the input for a request action. |
CreateFleetOutput | Represents the returned data in response to a request action. |
CreateGameSessionInput | Represents the input for a request action. |
CreateGameSessionOutput | Represents the returned data in response to a request action. |
CreateGameSessionQueueInput | Represents the input for a request action. |
CreateGameSessionQueueOutput | Represents the returned data in response to a request action. |
CreateMatchmakingConfigurationInput | Represents the input for a request action. |
CreateMatchmakingConfigurationOutput | Represents the returned data in response to a request action. |
CreateMatchmakingRuleSetInput | Represents the input for a request action. |
CreateMatchmakingRuleSetOutput | Represents the returned data in response to a request action. |
CreatePlayerSessionInput | Represents the input for a request action. |
CreatePlayerSessionOutput | Represents the returned data in response to a request action. |
CreatePlayerSessionsInput | Represents the input for a request action. |
CreatePlayerSessionsOutput | Represents the returned data in response to a request action. |
CreateScriptInput | |
CreateScriptOutput | |
CreateVpcPeeringAuthorizationInput | Represents the input for a request action. |
CreateVpcPeeringAuthorizationOutput | Represents the returned data in response to a request action. |
CreateVpcPeeringConnectionInput | Represents the input for a request action. |
CreateVpcPeeringConnectionOutput | |
DeleteAliasInput | Represents the input for a request action. |
DeleteBuildInput | Represents the input for a request action. |
DeleteFleetInput | Represents the input for a request action. |
DeleteGameSessionQueueInput | Represents the input for a request action. |
DeleteGameSessionQueueOutput | |
DeleteMatchmakingConfigurationInput | Represents the input for a request action. |
DeleteMatchmakingConfigurationOutput | |
DeleteMatchmakingRuleSetInput | Represents the input for a request action. |
DeleteMatchmakingRuleSetOutput | Represents the returned data in response to a request action. |
DeleteScalingPolicyInput | Represents the input for a request action. |
DeleteScriptInput | |
DeleteVpcPeeringAuthorizationInput | Represents the input for a request action. |
DeleteVpcPeeringAuthorizationOutput | |
DeleteVpcPeeringConnectionInput | Represents the input for a request action. |
DeleteVpcPeeringConnectionOutput | |
DescribeAliasInput | Represents the input for a request action. |
DescribeAliasOutput | Represents the returned data in response to a request action. |
DescribeBuildInput | Represents the input for a request action. |
DescribeBuildOutput | Represents the returned data in response to a request action. |
DescribeEC2InstanceLimitsInput | Represents the input for a request action. |
DescribeEC2InstanceLimitsOutput | Represents the returned data in response to a request action. |
DescribeFleetAttributesInput | Represents the input for a request action. |
DescribeFleetAttributesOutput | Represents the returned data in response to a request action. |
DescribeFleetCapacityInput | Represents the input for a request action. |
DescribeFleetCapacityOutput | Represents the returned data in response to a request action. |
DescribeFleetEventsInput | Represents the input for a request action. |
DescribeFleetEventsOutput | Represents the returned data in response to a request action. |
DescribeFleetPortSettingsInput | Represents the input for a request action. |
DescribeFleetPortSettingsOutput | Represents the returned data in response to a request action. |
DescribeFleetUtilizationInput | Represents the input for a request action. |
DescribeFleetUtilizationOutput | Represents the returned data in response to a request action. |
DescribeGameSessionDetailsInput | Represents the input for a request action. |
DescribeGameSessionDetailsOutput | Represents the returned data in response to a request action. |
DescribeGameSessionPlacementInput | Represents the input for a request action. |
DescribeGameSessionPlacementOutput | Represents the returned data in response to a request action. |
DescribeGameSessionQueuesInput | Represents the input for a request action. |
DescribeGameSessionQueuesOutput | Represents the returned data in response to a request action. |
DescribeGameSessionsInput | Represents the input for a request action. |
DescribeGameSessionsOutput | Represents the returned data in response to a request action. |
DescribeInstancesInput | Represents the input for a request action. |
DescribeInstancesOutput | Represents the returned data in response to a request action. |
DescribeMatchmakingConfigurationsInput | Represents the input for a request action. |
DescribeMatchmakingConfigurationsOutput | Represents the returned data in response to a request action. |
DescribeMatchmakingInput | Represents the input for a request action. |
DescribeMatchmakingOutput | Represents the returned data in response to a request action. |
DescribeMatchmakingRuleSetsInput | Represents the input for a request action. |
DescribeMatchmakingRuleSetsOutput | Represents the returned data in response to a request action. |
DescribePlayerSessionsInput | Represents the input for a request action. |
DescribePlayerSessionsOutput | Represents the returned data in response to a request action. |
DescribeRuntimeConfigurationInput | Represents the input for a request action. |
DescribeRuntimeConfigurationOutput | Represents the returned data in response to a request action. |
DescribeScalingPoliciesInput | Represents the input for a request action. |
DescribeScalingPoliciesOutput | Represents the returned data in response to a request action. |
DescribeScriptInput | |
DescribeScriptOutput | |
DescribeVpcPeeringAuthorizationsInput | |
DescribeVpcPeeringAuthorizationsOutput | |
DescribeVpcPeeringConnectionsInput | Represents the input for a request action. |
DescribeVpcPeeringConnectionsOutput | Represents the returned data in response to a request action. |
DesiredPlayerSession | Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement. |
EC2InstanceCounts | Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.
|
EC2InstanceLimit | Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits. |
Event | 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. |
FleetAttributes | General properties describing a fleet.
|
FleetCapacity | 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.
|
FleetUtilization | Current status of fleet utilization, including the number of game and player sessions being hosted.
|
GameLiftClient | A client for the Amazon GameLift API. |
GameProperty | 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. |
GameSession | Properties describing a game session. A game session in ACTIVE status can host players. When a game session ends, its status is set to 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. |
GameSessionConnectionInfo | Connection information for the new game session that is created with matchmaking. (with StartMatchmaking). Once a match is set, the FlexMatch engine places the match and creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking. |
GameSessionDetail | A game session's properties plus the protection policy currently in force. |
GameSessionPlacement | Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps. Game session placement-related operations include: |
GameSessionQueue | Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
|
GameSessionQueueDestination | 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. |
GetGameSessionLogUrlInput | Represents the input for a request action. |
GetGameSessionLogUrlOutput | Represents the returned data in response to a request action. |
GetInstanceAccessInput | Represents the input for a request action. |
GetInstanceAccessOutput | Represents the returned data in response to a request action. |
Instance | 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. |
InstanceAccess | Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess. |
InstanceCredentials | Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object. |
IpPermission | A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers. |
ListAliasesInput | Represents the input for a request action. |
ListAliasesOutput | Represents the returned data in response to a request action. |
ListBuildsInput | Represents the input for a request action. |
ListBuildsOutput | Represents the returned data in response to a request action. |
ListFleetsInput | Represents the input for a request action. |
ListFleetsOutput | Represents the returned data in response to a request action. |
ListScriptsInput | |
ListScriptsOutput | |
MatchedPlayerSession | 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. |
MatchmakingConfiguration | Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration. |
MatchmakingRuleSet | 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.
|
MatchmakingTicket | 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. |
PlacedPlayerSession | 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. |
Player | 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. |
PlayerLatency | 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. |
PlayerLatencyPolicy | 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. |
PlayerSession | 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 When a player disconnects, the player session status changes to |
PutScalingPolicyInput | Represents the input for a request action. |
PutScalingPolicyOutput | Represents the returned data in response to a request action. |
RequestUploadCredentialsInput | Represents the input for a request action. |
RequestUploadCredentialsOutput | Represents the returned data in response to a request action. |
ResolveAliasInput | Represents the input for a request action. |
ResolveAliasOutput | Represents the returned data in response to a request action. |
ResourceCreationLimitPolicy | Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period". The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a |
RoutingStrategy | Routing configuration for a fleet alias.
|
RuntimeConfiguration | A collection of server process configurations that describe what processes to run on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instance in the fleet starts the specified server processes and continues to start new processes as existing processes end. An instance regularly checks for an updated run-time configuration. The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Learn more about Running Multiple Processes on a Fleet . A Amazon GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes in a run-time configuration, add the values of the
|
S3Location | Location in Amazon Simple Storage Service (Amazon S3) where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests. |
ScalingPolicy | Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
|
Script | Properties describing a Realtime script. Related operations |
SearchGameSessionsInput | Represents the input for a request action. |
SearchGameSessionsOutput | Represents the returned data in response to a request action. |
ServerProcess | A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, 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 |
StartFleetActionsInput | |
StartFleetActionsOutput | |
StartGameSessionPlacementInput | Represents the input for a request action. |
StartGameSessionPlacementOutput | Represents the returned data in response to a request action. |
StartMatchBackfillInput | Represents the input for a request action. |
StartMatchBackfillOutput | Represents the returned data in response to a request action. |
StartMatchmakingInput | Represents the input for a request action. |
StartMatchmakingOutput | Represents the returned data in response to a request action. |
StopFleetActionsInput | |
StopFleetActionsOutput | |
StopGameSessionPlacementInput | Represents the input for a request action. |
StopGameSessionPlacementOutput | Represents the returned data in response to a request action. |
StopMatchmakingInput | Represents the input for a request action. |
StopMatchmakingOutput | |
TargetConfiguration | Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.
|
UpdateAliasInput | Represents the input for a request action. |
UpdateAliasOutput | Represents the returned data in response to a request action. |
UpdateBuildInput | Represents the input for a request action. |
UpdateBuildOutput | Represents the returned data in response to a request action. |
UpdateFleetAttributesInput | Represents the input for a request action. |
UpdateFleetAttributesOutput | Represents the returned data in response to a request action. |
UpdateFleetCapacityInput | Represents the input for a request action. |
UpdateFleetCapacityOutput | Represents the returned data in response to a request action. |
UpdateFleetPortSettingsInput | Represents the input for a request action. |
UpdateFleetPortSettingsOutput | Represents the returned data in response to a request action. |
UpdateGameSessionInput | Represents the input for a request action. |
UpdateGameSessionOutput | Represents the returned data in response to a request action. |
UpdateGameSessionQueueInput | Represents the input for a request action. |
UpdateGameSessionQueueOutput | Represents the returned data in response to a request action. |
UpdateMatchmakingConfigurationInput | Represents the input for a request action. |
UpdateMatchmakingConfigurationOutput | Represents the returned data in response to a request action. |
UpdateRuntimeConfigurationInput | Represents the input for a request action. |
UpdateRuntimeConfigurationOutput | Represents the returned data in response to a request action. |
UpdateScriptInput | |
UpdateScriptOutput | |
ValidateMatchmakingRuleSetInput | Represents the input for a request action. |
ValidateMatchmakingRuleSetOutput | Represents the returned data in response to a request action. |
VpcPeeringAuthorization | 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. |
VpcPeeringConnection | 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. |
VpcPeeringConnectionStatus | Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event. |
Enums
AcceptMatchError | Errors returned by AcceptMatch |
CreateAliasError | Errors returned by CreateAlias |
CreateBuildError | Errors returned by CreateBuild |
CreateFleetError | Errors returned by CreateFleet |
CreateGameSessionError | Errors returned by CreateGameSession |
CreateGameSessionQueueError | Errors returned by CreateGameSessionQueue |
CreateMatchmakingConfigurationError | Errors returned by CreateMatchmakingConfiguration |
CreateMatchmakingRuleSetError | Errors returned by CreateMatchmakingRuleSet |
CreatePlayerSessionError | Errors returned by CreatePlayerSession |
CreatePlayerSessionsError | Errors returned by CreatePlayerSessions |
CreateScriptError | Errors returned by CreateScript |
CreateVpcPeeringAuthorizationError | Errors returned by CreateVpcPeeringAuthorization |
CreateVpcPeeringConnectionError | Errors returned by CreateVpcPeeringConnection |
DeleteAliasError | Errors returned by DeleteAlias |
DeleteBuildError | Errors returned by DeleteBuild |
DeleteFleetError | Errors returned by DeleteFleet |
DeleteGameSessionQueueError | Errors returned by DeleteGameSessionQueue |
DeleteMatchmakingConfigurationError | Errors returned by DeleteMatchmakingConfiguration |
DeleteMatchmakingRuleSetError | Errors returned by DeleteMatchmakingRuleSet |
DeleteScalingPolicyError | Errors returned by DeleteScalingPolicy |
DeleteScriptError | Errors returned by DeleteScript |
DeleteVpcPeeringAuthorizationError | Errors returned by DeleteVpcPeeringAuthorization |
DeleteVpcPeeringConnectionError | Errors returned by DeleteVpcPeeringConnection |
DescribeAliasError | Errors returned by DescribeAlias |
DescribeBuildError | Errors returned by DescribeBuild |
DescribeEC2InstanceLimitsError | Errors returned by DescribeEC2InstanceLimits |
DescribeFleetAttributesError | Errors returned by DescribeFleetAttributes |
DescribeFleetCapacityError | Errors returned by DescribeFleetCapacity |
DescribeFleetEventsError | Errors returned by DescribeFleetEvents |
DescribeFleetPortSettingsError | Errors returned by DescribeFleetPortSettings |
DescribeFleetUtilizationError | Errors returned by DescribeFleetUtilization |
DescribeGameSessionDetailsError | Errors returned by DescribeGameSessionDetails |
DescribeGameSessionPlacementError | Errors returned by DescribeGameSessionPlacement |
DescribeGameSessionQueuesError | Errors returned by DescribeGameSessionQueues |
DescribeGameSessionsError | Errors returned by DescribeGameSessions |
DescribeInstancesError | Errors returned by DescribeInstances |
DescribeMatchmakingConfigurationsError | Errors returned by DescribeMatchmakingConfigurations |
DescribeMatchmakingError | Errors returned by DescribeMatchmaking |
DescribeMatchmakingRuleSetsError | Errors returned by DescribeMatchmakingRuleSets |
DescribePlayerSessionsError | Errors returned by DescribePlayerSessions |
DescribeRuntimeConfigurationError | Errors returned by DescribeRuntimeConfiguration |
DescribeScalingPoliciesError | Errors returned by DescribeScalingPolicies |
DescribeScriptError | Errors returned by DescribeScript |
DescribeVpcPeeringAuthorizationsError | Errors returned by DescribeVpcPeeringAuthorizations |
DescribeVpcPeeringConnectionsError | Errors returned by DescribeVpcPeeringConnections |
GetGameSessionLogUrlError | Errors returned by GetGameSessionLogUrl |
GetInstanceAccessError | Errors returned by GetInstanceAccess |
ListAliasesError | Errors returned by ListAliases |
ListBuildsError | Errors returned by ListBuilds |
ListFleetsError | Errors returned by ListFleets |
ListScriptsError | Errors returned by ListScripts |
PutScalingPolicyError | Errors returned by PutScalingPolicy |
RequestUploadCredentialsError | Errors returned by RequestUploadCredentials |
ResolveAliasError | Errors returned by ResolveAlias |
SearchGameSessionsError | Errors returned by SearchGameSessions |
StartFleetActionsError | Errors returned by StartFleetActions |
StartGameSessionPlacementError | Errors returned by StartGameSessionPlacement |
StartMatchBackfillError | Errors returned by StartMatchBackfill |
StartMatchmakingError | Errors returned by StartMatchmaking |
StopFleetActionsError | Errors returned by StopFleetActions |
StopGameSessionPlacementError | Errors returned by StopGameSessionPlacement |
StopMatchmakingError | Errors returned by StopMatchmaking |
UpdateAliasError | Errors returned by UpdateAlias |
UpdateBuildError | Errors returned by UpdateBuild |
UpdateFleetAttributesError | Errors returned by UpdateFleetAttributes |
UpdateFleetCapacityError | Errors returned by UpdateFleetCapacity |
UpdateFleetPortSettingsError | Errors returned by UpdateFleetPortSettings |
UpdateGameSessionError | Errors returned by UpdateGameSession |
UpdateGameSessionQueueError | Errors returned by UpdateGameSessionQueue |
UpdateMatchmakingConfigurationError | Errors returned by UpdateMatchmakingConfiguration |
UpdateRuntimeConfigurationError | Errors returned by UpdateRuntimeConfiguration |
UpdateScriptError | Errors returned by UpdateScript |
ValidateMatchmakingRuleSetError | Errors returned by ValidateMatchmakingRuleSet |
Traits
GameLift | Trait representing the capabilities of the Amazon GameLift API. Amazon GameLift clients implement this trait. |