Amazon.GameLift.Model.Internal |
Name | Description |
---|---|
Alias | Properties describing a fleet alias. |
Build | Properties describing a game build. |
ConflictException | |
CreateAliasRequest | Container for the parameters to the CreateAlias operation. Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error. To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias. |
CreateBuildRequest | Container for the parameters to the CreateBuild operation. Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once the build record has been created and its status is INITIALIZED , you can upload your game build. Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files. Instead, to create a build, use the CLI command To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build. |
CreateBuildResponse | Represents the returned data in response to a request action. |
CreateFleetRequest | Container for the parameters to the CreateFleet operation. 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 configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions. To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store. If the
After a fleet is created, use the following actions to change fleet properties and configuration:
|
CreateGameSessionRequest | Container for the parameters to the CreateGameSession operation. 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 be in 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 session properties, including an IP address. By default, newly created game sessions allow new players to join. Use UpdateGameSession to change the game sessions player session creation policy. When creating a game session on a fleet with a resource limit creation policy, the request should include a creator ID. If none is provided, GameLift does not evaluate the fleet's resource limit creation policy. |
CreatePlayerSessionRequest | Container for the parameters to the CreatePlayerSession operation. Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL , and have an open player slot before players can be added to the session. To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned. |
CreatePlayerSessionsRequest | Container for the parameters to the CreatePlayerSessions operation. Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL , and have an open player slot before players can be added to the session. To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. |
DeleteAliasRequest | Container for the parameters to the DeleteAlias operation. 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. |
DeleteBuildRequest | Container for the parameters to the DeleteBuild operation. 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. |
DeleteScalingPolicyRequest | Container for the parameters to the DeleteScalingPolicy operation. 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. |
DescribeAliasRequest | Container for the parameters to the DescribeAlias operation. Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned. |
DescribeBuildRequest | Container for the parameters to the DescribeBuild operation. Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned. |
DescribeEC2InstanceLimitsRequest | Container for the parameters to the DescribeEC2InstanceLimits operation. Retrieves the following information for the specified EC2 instance type:
Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner). |
DescribeFleetAttributesRequest | Container for the parameters to the DescribeFleetAttributes operation. 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. 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. |
DescribeFleetAttributesResponse | Represents the returned data in response to a request action. |
DescribeFleetCapacityRequest | Container for the parameters to the DescribeFleetCapacity operation. 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. 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. |
DescribeFleetCapacityResponse | Represents the returned data in response to a request action. |
DescribeFleetEventsRequest | Container for the parameters to the DescribeFleetEvents operation. 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. |
DescribeFleetEventsResponse | Represents the returned data in response to a request action. |
DescribeFleetPortSettingsRequest | Container for the parameters to the DescribeFleetPortSettings operation. 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. |
DescribeFleetUtilizationRequest | Container for the parameters to the DescribeFleetUtilization operation. 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. 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. |
DescribeFleetUtilizationResponse | Represents the returned data in response to a request action. |
DescribeGameSessionDetailsRequest | Container for the parameters to the DescribeGameSessionDetails operation. 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 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. |
DescribeGameSessionDetailsResponse | Represents the returned data in response to a request action. |
DescribeGameSessionsRequest | Container for the parameters to the DescribeGameSessions operation. Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide a GameSessionId to request properties for a specific game session; (2) provide a FleetId or an AliasId to request properties for all game sessions running on a fleet. You can also use SearchGameSessions, which allows you to retrieve all game sessions or filter on certain criteria, but only returns game sessions with a status of ACTIVE. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails. 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 GameSession object is returned for each session matching the request. |
DescribeGameSessionsResponse | Represents the returned data in response to a request action. |
DescribeInstancesRequest | Container for the parameters to the DescribeInstances operation. 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. |
DescribeInstancesResponse | Represents the returned data in response to a request action. |
DescribePlayerSessionsRequest | Container for the parameters to the DescribePlayerSessions operation. Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId parameter to request properties for a specific player session; (2) provide a GameSessionId parameter to request properties for all player sessions in the specified game session; (3) provide a PlayerId parameter 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. |
DescribePlayerSessionsResponse | Represents the returned data in response to a request action. |
DescribeRuntimeConfigurationRequest | Container for the parameters to the DescribeRuntimeConfiguration operation. Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet. |
DescribeRuntimeConfigurationResponse | Represents the returned data in response to a request action. |
DescribeScalingPoliciesRequest | Container for the parameters to the DescribeScalingPolicies operation. 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. |
DescribeScalingPoliciesResponse | Represents the returned data in response to a request action. |
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 involving 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. |
FleetCapacityExceededException | |
FleetUtilization | Current status of fleet utilization, including the number of game and player sessions being hosted. |
GameProperty | Set of key-value pairs containing information a server process requires to set up a game session. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide. |
GameSessionDetail | A game session's properties and the protection policy currently in force. |
GameSessionFullException | |
GetGameSessionLogUrlRequest | Container for the parameters to the GetGameSessionLogUrl operation. 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. Use this URL to download the logs. See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved. |
GetInstanceAccessRequest | Container for the parameters to the GetInstanceAccess operation. 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, GameLift returns a username and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a username 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 the instance and the fleet it belongs to. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials. |
GetInstanceAccessResponse | This is the response object from the GetInstanceAccess operation. |
IdempotentParameterMismatchException | |
Instance | Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet contains 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. |
InternalServiceException | |
InvalidFleetStatusException | |
InvalidGameSessionStatusException | |
InvalidRequestException | |
IpPermission | A range of IP addresses and port settings that allow inbound traffic to connect to server processes on 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. |
LimitExceededException | |
ListAliasesRequest | Container for the parameters to the ListAliases operation. Retrieves a collection of alias records 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. Aliases are not listed in any particular order. |
ListAliasesResponse | Represents the returned data in response to a request action. |
ListBuildsRequest | Container for the parameters to the ListBuilds operation. 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. Build records are not listed in any particular order. |
ListBuildsResponse | Represents the returned data in response to a request action. |
ListFleetsRequest | Container for the parameters to the ListFleets operation. 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. Fleet records are not listed in any particular order. |
ListFleetsResponse | Represents the returned data in response to a request action. |
NotFoundException | |
PlayerSession | Properties describing a player session. |
PutScalingPolicyRequest | Container for the parameters to the PutScalingPolicy operation. Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously. A scaling policy rule statement has the following structure: If For example, this policy: "If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances" could be implemented as the following rule statement: If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10]. To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy. |
PutScalingPolicyResponse | Represents the returned data in response to a request action. |
RequestUploadCredentialsRequest | Container for the parameters to the RequestUploadCredentials operation. Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3. Call this action only if you need credentials for a build created with Upload credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files until the status of that build changes to |
ResolveAliasRequest | Container for the parameters to the ResolveAlias operation. Retrieves the fleet ID that a specified alias is currently pointing to. |
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 | Collection of server process configurations that describe what processes should be run on each instance in a fleet. An instance can launch and maintain multiple server processes based on the runtime configuration; it regularly checks for an updated runtime configuration and starts new server processes to match the latest version. The key purpose of a runtime configuration with multiple server process configurations is to be able to run more than one kind of game server in a single fleet. You can include configurations for more than one server executable in order to run two or more different programs to run on the same instance. This option might be useful, for example, to run more than one version of your game server on the same fleet. Another option is to specify configurations for the same server executable but with different launch parameters. A GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes specified in a runtime configuration, add the values of the |
S3Location | Location in Amazon Simple Storage Service (Amazon S3) where a build's files are stored. This location is assigned in response to a CreateBuild call, and is always in the same region as the service used to create the build. For more details see the Amazon S3 documentation. |
ScalingPolicy | Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID. |
SearchGameSessionsRequest | Container for the parameters to the SearchGameSessions operation. Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. Currently a game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails. You can search or sort by the following game session attributes:
To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned. Returned values for |
SearchGameSessionsResponse | 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. 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 . |
TerminalRoutingStrategyException | |
UnauthorizedException | |
UpdateAliasRequest | Container for the parameters to the UpdateAlias operation. 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. |
UpdateBuildRequest | Container for the parameters to the UpdateBuild operation. 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. |
UpdateFleetAttributesRequest | Container for the parameters to the UpdateFleetAttributes operation. Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned. |
UpdateFleetCapacityRequest | Container for the parameters to the UpdateFleetCapacity operation. 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. If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits. 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. |
UpdateFleetPortSettingsRequest | Container for the parameters to the UpdateFleetPortSettings operation. 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. |
UpdateGameSessionRequest | Container for the parameters to the UpdateGameSession operation. 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. |
UpdateRuntimeConfigurationRequest | Container for the parameters to the UpdateRuntimeConfiguration operation. Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE status. To update runtime configuration, specify the fleet ID and provide a Each instance in a GameLift fleet checks regularly for an updated runtime 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 GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity. |
UpdateRuntimeConfigurationResponse | Represents the returned data in response to a request action. |