AbstractAmazonGameLift (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gamelift.AbstractAmazonGameLift

All Implemented Interfaces:

AmazonGameLift

Direct Known Subclasses:

AbstractAmazonGameLiftAsync
```
public class AbstractAmazonGameLift
extends Object
implements AmazonGameLift
```
Abstract implementation of AmazonGameLift. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Method Summary

Methods
Modifier and Type	Method and Description
`CreateAliasResult`	`createAlias(CreateAliasRequest request)` Creates an alias for a fleet.
`CreateBuildResult`	`createBuild(CreateBuildRequest request)` Initializes a new build record and generates information required to upload a game build to Amazon GameLift.
`CreateFleetResult`	`createFleet(CreateFleetRequest request)` Creates a new fleet to host game servers.
`CreateGameSessionResult`	`createGameSession(CreateGameSessionRequest request)` Creates a multiplayer game session for players.
`CreatePlayerSessionResult`	`createPlayerSession(CreatePlayerSessionRequest request)` Adds a player to a game session and creates a player session record.
`CreatePlayerSessionsResult`	`createPlayerSessions(CreatePlayerSessionsRequest request)` Adds a group of players to a game session.
`void`	`deleteAlias(DeleteAliasRequest request)` Deletes an alias.
`void`	`deleteBuild(DeleteBuildRequest request)` Deletes a build.
`void`	`deleteFleet(DeleteFleetRequest request)` Deletes everything related to a fleet.
`void`	`deleteScalingPolicy(DeleteScalingPolicyRequest request)` Deletes a fleet scaling policy.
`DescribeAliasResult`	`describeAlias(DescribeAliasRequest request)` Retrieves properties for a specified alias.
`DescribeBuildResult`	`describeBuild(DescribeBuildRequest request)` Retrieves properties for a build.
`DescribeEC2InstanceLimitsResult`	`describeEC2InstanceLimits(DescribeEC2InstanceLimitsRequest request)` Retrieves the following information for the specified EC2 instance type:
`DescribeFleetAttributesResult`	`describeFleetAttributes(DescribeFleetAttributesRequest request)` Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets.
`DescribeFleetCapacityResult`	`describeFleetCapacity(DescribeFleetCapacityRequest request)` Retrieves the current status of fleet capacity for one or more fleets.
`DescribeFleetEventsResult`	`describeFleetEvents(DescribeFleetEventsRequest request)` Retrieves entries from the fleet event log.
`DescribeFleetPortSettingsResult`	`describeFleetPortSettings(DescribeFleetPortSettingsRequest request)` Retrieves the port settings for a fleet.
`DescribeFleetUtilizationResult`	`describeFleetUtilization(DescribeFleetUtilizationRequest request)` Retrieves utilization statistics for one or more fleets.
`DescribeGameSessionDetailsResult`	`describeGameSessionDetails(DescribeGameSessionDetailsRequest request)` Retrieves properties, including the protection policy in force, for one or more game sessions.
`DescribeGameSessionsResult`	`describeGameSessions(DescribeGameSessionsRequest request)` Retrieves properties for one or more game sessions.
`DescribePlayerSessionsResult`	`describePlayerSessions(DescribePlayerSessionsRequest request)` Retrieves properties for one or more player sessions.
`DescribeScalingPoliciesResult`	`describeScalingPolicies(DescribeScalingPoliciesRequest request)` Retrieves all scaling policies applied to a fleet.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetGameSessionLogUrlResult`	`getGameSessionLogUrl(GetGameSessionLogUrlRequest request)` Retrieves the location of stored game session logs for a specified game session.
`ListAliasesResult`	`listAliases(ListAliasesRequest request)` Retrieves a collection of alias records for this AWS account.
`ListBuildsResult`	`listBuilds(ListBuildsRequest request)` Retrieves build records for all builds associated with an AWS account.
`ListFleetsResult`	`listFleets(ListFleetsRequest request)` Retrieves a collection of fleet records for this AWS account.
`PutScalingPolicyResult`	`putScalingPolicy(PutScalingPolicyRequest request)` Creates or updates a scaling policy for a fleet.
`RequestUploadCredentialsResult`	`requestUploadCredentials(RequestUploadCredentialsRequest request)` Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build.
`ResolveAliasResult`	`resolveAlias(ResolveAliasRequest request)` Retrieves the fleet ID that a specified alias is currently pointing to.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://gamelift.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonGameLift.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateAliasResult`	`updateAlias(UpdateAliasRequest request)` Updates properties for an alias.
`UpdateBuildResult`	`updateBuild(UpdateBuildRequest request)` Updates metadata in a build record, including the build name and version.
`UpdateFleetAttributesResult`	`updateFleetAttributes(UpdateFleetAttributesRequest request)` Updates fleet properties, including name and description, for a fleet.
`UpdateFleetCapacityResult`	`updateFleetCapacity(UpdateFleetCapacityRequest request)` Updates capacity settings for a fleet.
`UpdateFleetPortSettingsResult`	`updateFleetPortSettings(UpdateFleetPortSettingsRequest request)` Updates port settings for a fleet.
`UpdateGameSessionResult`	`updateGameSession(UpdateGameSessionRequest request)` Updates game session properties.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonGameLift
    
    Overrides the default endpoint for this client ("https://gamelift.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "gamelift.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://gamelift.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonGameLift
    
    Parameters:
    endpoint - The endpoint (ex: "gamelift.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://gamelift.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonGameLift
    
    An alternative to AmazonGameLift.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonGameLift
    
    Parameters:
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    See Also:
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - createAlias
```
public CreateAliasResult createAlias(CreateAliasRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    createAlias in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the CreateAlias operation returned by the service.
  - createBuild
```
public CreateBuildResult createBuild(CreateBuildRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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 is in an INITIALIZED state, you can upload your game build.
    
    To create a build, use the CLI command upload-build, which creates a new build record and uploads the build files in one step. (See the Amazon GameLift Developer Guide for more details on the CLI and the upload process.) Call the CreateBuild action only if you have your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files.
    
    To create a new build, 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 (but not visible to players). If successful, this action returns the newly created build record along with an Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
    
    Specified by:
    
    createBuild in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the CreateBuild operation returned by the service.
  - createFleet
```
public CreateFleetResult createFleet(CreateFleetRequest request)
```
    Description copied from interface: AmazonGameLift
    Creates a new fleet to host game servers. A fleet consists of a set of Amazon Elastic Compute Cloud (Amazon EC2) instances of a certain type, which defines the CPU, memory, storage, and networking capacity of each host in the fleet. See Amazon EC2 Instance Types for more information. Each instance in the fleet hosts a game server created from the specified game build. Once a fleet is in an ACTIVE state, it can begin hosting game sessions.
    
    To create a new fleet, provide a name and the EC2 instance type for the new fleet, and specify the build and server launch path. Builds must be in a READY state before they can be used to build fleets. When configuring the new fleet, you can optionally (1) provide a set of launch parameters to be passed to a game server when activated; (2) limit incoming traffic to a specified range of IP addresses and port numbers; (3) set game session protection for all instances in the fleet, and (4) configure Amazon GameLift to store game session logs by specifying the path to the logs stored in your game server files. If the call is successful, Amazon GameLift performs the following tasks:
    - Creates a fleet record and sets the state to NEW.
    - Sets the fleet's capacity to 1 "desired" and 1 "active" EC2 instance count.
    - Creates an EC2 instance and begins the process of initializing the fleet and activating a game server on the instance.
    - Begins writing events to the fleet event log, which can be accessed in the GameLift console.
    Once a fleet is created, use the following actions to change certain fleet properties (server launch parameters and log paths cannot be changed):
    - UpdateFleetAttributes -- Update fleet metadata, including name and description.
    - UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.
    - UpdateFleetPortSettings -- Change the IP addresses and ports that allow access to incoming traffic.
    Specified by:
    
    createFleet in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the CreateFleet operation returned by the service.
  - createGameSession
```
public CreateGameSessionResult createGameSession(CreateGameSessionRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which activates the server initialization process in your game server. A fleet must be in an ACTIVE state before a game session can be created for it.
    
    To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session allows. You can also provide a name and a set of properties for your game (optional). If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use UpdateGameSession to change the creation policy.
    
    Specified by:
    
    createGameSession in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the CreateGameSession operation returned by the service.
  - createPlayerSession
```
public CreatePlayerSessionResult createPlayerSession(CreatePlayerSessionRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE state, 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.
    
    Specified by:
    
    createPlayerSession in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the CreatePlayerSession operation returned by the service.
  - createPlayerSessions
```
public CreatePlayerSessionsResult createPlayerSessions(CreatePlayerSessionsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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 state, 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.
    
    Specified by:
    
    createPlayerSessions in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the CreatePlayerSessions operation returned by the service.
  - deleteAlias
```
public void deleteAlias(DeleteAliasRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Deletes an alias. This action removes all record of the alias; game clients attempting to access a game server using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.
    
    Specified by:
    
    deleteAlias in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
  - deleteBuild
```
public void deleteBuild(DeleteBuildRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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, but you can no longer create new fleets for the deleted build.
    
    Specified by:
    
    deleteBuild in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
  - deleteFleet
```
public void deleteFleet(DeleteFleetRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    deleteFleet in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
  - deleteScalingPolicy
```
public void deleteScalingPolicy(DeleteScalingPolicyRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    deleteScalingPolicy in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
  - describeAlias
```
public DescribeAliasResult describeAlias(DescribeAliasRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
    
    Specified by:
    
    describeAlias in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeAlias operation returned by the service.
  - describeBuild
```
public DescribeBuildResult describeBuild(DescribeBuildRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
    
    Specified by:
    
    describeBuild in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeBuild operation returned by the service.
  - describeEC2InstanceLimits
```
public DescribeEC2InstanceLimitsResult describeEC2InstanceLimits(DescribeEC2InstanceLimitsRequest request)
```
    Description copied from interface: AmazonGameLift
    Retrieves the following information for the specified EC2 instance type:
    - maximum number of instances allowed per AWS account (service limit)
    - current usage level for the AWS account
    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).
    Specified by:
    
    describeEC2InstanceLimits in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeEC2InstanceLimits operation returned by the service.
  - describeFleetAttributes
```
public DescribeFleetAttributesResult describeFleetAttributes(DescribeFleetAttributesRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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 all 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.
    
    Specified by:
    
    describeFleetAttributes in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeFleetAttributes operation returned by the service.
  - describeFleetCapacity
```
public DescribeFleetCapacityResult describeFleetCapacity(DescribeFleetCapacityRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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 all 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.
    
    Specified by:
    
    describeFleetCapacity in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeFleetCapacity operation returned by the service.
  - describeFleetEvents
```
public DescribeFleetEventsResult describeFleetEvents(DescribeFleetEventsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves entries from the fleet 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.
    
    Specified by:
    
    describeFleetEvents in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeFleetEvents operation returned by the service.
  - describeFleetPortSettings
```
public DescribeFleetPortSettingsResult describeFleetPortSettings(DescribeFleetPortSettingsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves the port settings for a fleet. Port settings are used to limit incoming traffic access to game servers in the fleet. To get a fleet's port settings, specify a fleet ID. If successful, an IpPermission object is returned for the requested fleet ID. If the requested fleet has been deleted, the result set will be empty.
    
    Specified by:
    
    describeFleetPortSettings in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeFleetPortSettings operation returned by the service.
  - describeFleetUtilization
```
public DescribeFleetUtilizationResult describeFleetUtilization(DescribeFleetUtilizationRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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 all 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.
    
    Specified by:
    
    describeFleetUtilization in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeFleetUtilization operation returned by the service.
  - describeGameSessionDetails
```
public DescribeGameSessionDetailsResult describeGameSessionDetails(DescribeGameSessionDetailsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    describeGameSessionDetails in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeGameSessionDetails operation returned by the service.
  - describeGameSessions
```
public DescribeGameSessionsResult describeGameSessions(DescribeGameSessionsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves properties for one or more game sessions. 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.
    
    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.
    
    Specified by:
    
    describeGameSessions in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeGameSessions operation returned by the service.
  - describePlayerSessions
```
public DescribePlayerSessionsResult describePlayerSessions(DescribePlayerSessionsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    describePlayerSessions in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribePlayerSessions operation returned by the service.
  - describeScalingPolicies
```
public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    describeScalingPolicies in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the DescribeScalingPolicies operation returned by the service.
  - getGameSessionLogUrl
```
public GetGameSessionLogUrlResult getGameSessionLogUrl(GetGameSessionLogUrlRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    getGameSessionLogUrl in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the GetGameSessionLogUrl operation returned by the service.
  - listAliases
```
public ListAliasesResult listAliases(ListAliasesRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    listAliases in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the ListAliases operation returned by the service.
  - listBuilds
```
public ListBuildsResult listBuilds(ListBuildsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves build records for all builds associated with an AWS account. You can filter the result set by build status. Use the pagination parameters to retrieve results in a set of sequential pages.
    
    Build records are not listed in any particular order.
    
    Specified by:
    
    listBuilds in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the ListBuilds operation returned by the service.
  - listFleets
```
public ListFleetsResult listFleets(ListFleetsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    listFleets in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the ListFleets operation returned by the service.
  - putScalingPolicy
```
public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Creates or updates a scaling policy for a fleet. An active scaling policy prompts 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 [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
    
    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.
    
    Specified by:
    
    putScalingPolicy in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the PutScalingPolicy operation returned by the service.
  - requestUploadCredentials
```
public RequestUploadCredentialsResult requestUploadCredentials(RequestUploadCredentialsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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 CreateBuild. This is a rare situation; in most cases, builds are created using the CLI command upload-build, which creates a build record and also uploads build files.
    
    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 state of that build changes to READY. Once this happens, you must create a brand new build.
    
    Specified by:
    
    requestUploadCredentials in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the RequestUploadCredentials operation returned by the service.
  - resolveAlias
```
public ResolveAliasResult resolveAlias(ResolveAliasRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Retrieves the fleet ID that a specified alias is currently pointing to.
    
    Specified by:
    
    resolveAlias in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the ResolveAlias operation returned by the service.
  - updateAlias
```
public UpdateAliasResult updateAlias(UpdateAliasRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    updateAlias in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the UpdateAlias operation returned by the service.
  - updateBuild
```
public UpdateBuildResult updateBuild(UpdateBuildRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    updateBuild in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the UpdateBuild operation returned by the service.
  - updateFleetAttributes
```
public UpdateFleetAttributesResult updateFleetAttributes(UpdateFleetAttributesRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    updateFleetAttributes in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the UpdateFleetAttributes operation returned by the service.
  - updateFleetCapacity
```
public UpdateFleetCapacityResult updateFleetCapacity(UpdateFleetCapacityRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) 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 auto-scaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these boundaries, auto-scaling can set capacity anywhere between zero and the service limits.
    
    To update fleet capacity, specify the fleet ID and the desired number of instances. 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 will occur.
    
    Specified by:
    
    updateFleetCapacity in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the UpdateFleetCapacity operation returned by the service.
  - updateFleetPortSettings
```
public UpdateFleetPortSettingsResult updateFleetPortSettings(UpdateFleetPortSettingsRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    updateFleetPortSettings in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the UpdateFleetPortSettings operation returned by the service.
  - updateGameSession
```
public UpdateGameSessionResult updateGameSession(UpdateGameSessionRequest request)
```
    Description copied from interface: AmazonGameLift
    
    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.
    
    Specified by:
    
    updateGameSession in interface AmazonGameLift
    
    Parameters:
    request - Represents the input for a request action.
    
    Returns:
    Result of the UpdateGameSession operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonGameLift
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonGameLift
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonGameLift
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonGameLift
    
    Parameters:
    request - The originally executed request.
    
    Returns:
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonGameLift

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

createAlias

createBuild

createFleet

createGameSession

createPlayerSession

createPlayerSessions

deleteAlias

deleteBuild

deleteFleet

deleteScalingPolicy

describeAlias

describeBuild

describeEC2InstanceLimits

describeFleetAttributes

describeFleetCapacity

describeFleetEvents

describeFleetPortSettings

describeFleetUtilization

describeGameSessionDetails

describeGameSessions

describePlayerSessions

describeScalingPolicies

getGameSessionLogUrl

listAliases

listBuilds

listFleets

putScalingPolicy

requestUploadCredentials

resolveAlias

updateAlias

updateBuild

updateFleetAttributes

updateFleetCapacity

updateFleetPortSettings

updateGameSession

shutdown

getCachedResponseMetadata