com.amazonaws.services.gamelift.AmazonGameLift Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.gamelift;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.gamelift.model.*;
/**
* Interface for accessing Amazon GameLift.
*
* Amazon GameLift Service
*
* Welcome to the Amazon GameLift API Reference. Amazon GameLift is a managed Amazon Web Services (AWS) service
* for developers who need a scalable, server-based solution for multiplayer games. Amazon GameLift provides setup and
* deployment of game servers, and handles infrastructure scaling and session management.
*
*
* This reference describes the low-level service API for GameLift. You can call this API directly or use the AWS SDK for your preferred language. The AWS SDK includes a set of
* high-level GameLift actions multiplayer game sessions. Alternatively, you can use the AWS command-line interface (CLI) tool, which includes commands for GameLift.
* For administrative actions, you can also use the Amazon GameLift console.
*
*
* More Resources
*
*
* - Amazon GameLift Developer Guide: Learn
* more about GameLift features and how to use them
* - Lumberyard and GameLift Tutorials: Get started fast
* with walkthroughs and sample projects
* - GameDev Blog: Stay up to date with new features and
* techniques
* - GameDev Forums: Connect with
* the GameDev community
*
*
* Manage Games and Players Through GameLift
*
*
* Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player
* sessions.
*
*
* - Game sessions
*
*
* - Player sessions
*
*
* - Other actions:
*
*
*
*
* Set Up and Manage Game Servers
*
*
* Use these administrative actions to configure GameLift to host your game servers. When setting up GameLift, you'll
* need to (1) configure a build for your game and upload build files, and (2) set up one or more fleets to host game
* sessions. Once you've created and activated a fleet, you can assign aliases to it, scale capacity, track performance
* and utilization, etc.
*
*
* - Manage your builds:
*
*
* - Manage your fleets:
*
* - ListFleets
* - CreateFleet
* - Describe fleets:
*
*
* - Update fleets:
*
*
* - DeleteFleet
*
*
* - Manage fleet aliases:
*
* - ListAliases
* - CreateAlias
* - DescribeAlias
* - UpdateAlias
* - DeleteAlias
* - ResolveAlias
*
*
* - Manage autoscaling:
*
*
*
*
* To view changes to the API, see the GameLift Document History page.
*
*/
public interface AmazonGameLift {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "gamelift";
/**
* 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 {@link 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.
*
* @param 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.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link 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
* {@link 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.
*
* @param region
* The region this client will communicate with. See {@link 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 Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* 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.
*
*
* @param createAliasRequest
* Represents the input for a request action.
* @return Result of the CreateAlias operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws LimitExceededException
* The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue
* before retrying.
* @sample AmazonGameLift.CreateAlias
*/
CreateAliasResult createAlias(CreateAliasRequest createAliasRequest);
/**
*
* 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
* upload-build, which creates a new build record and uploads the build files in one step. (See the Amazon GameLift
* Developer Guide help on packaging and uploading your build.)
*
*
*
* 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.
*
*
* @param createBuildRequest
* Represents the input for a request action.
* @return Result of the CreateBuild operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.CreateBuild
*/
CreateBuildResult createBuild(CreateBuildRequest createBuildRequest);
/**
*
* 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 CreateFleet call is successful, Amazon GameLift performs the following tasks:
*
*
* - Creates a fleet record and sets the status to
NEW (followed by other statuses as the fleet is
* activated).
* - Sets the fleet's capacity to 1 "desired", which causes GameLift to start one new EC2 instance.
* - Starts launching server processes on the instance. If the fleet is configured to run multiple server
* processes per instance, GameLift staggers each launch by a few seconds.
* - Begins writing events to the fleet event log, which can be accessed in the GameLift console.
* - Sets the fleet's status to
ACTIVE once one server process in the fleet is ready to host a game
* session.
*
*
* After a fleet is created, use the following actions to change fleet properties and configuration:
*
*
* - 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 address and port ranges that allow access to incoming
* traffic.
* - UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch
* path, launch parameters, and the number of concurrent processes.
*
*
* @param createFleetRequest
* Represents the input for a request action.
* @return Result of the CreateFleet operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws LimitExceededException
* The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue
* before retrying.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.CreateFleet
*/
CreateFleetResult createFleet(CreateFleetRequest createFleetRequest);
/**
*
* 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 initializes a new server process 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 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.
*
*
* @param createGameSessionRequest
* Represents the input for a request action.
* @return Result of the CreateGameSession operation returned by the service.
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidFleetStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the fleet. Resolve the conflict before retrying.
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws FleetCapacityExceededException
* The specified fleet has no available instances to fulfill a request to create a new game session. Such
* requests should only be retried once the fleet capacity has been increased.
* @sample AmazonGameLift.CreateGameSession
*/
CreateGameSessionResult createGameSession(CreateGameSessionRequest createGameSessionRequest);
/**
*
* 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.
*
*
* @param createPlayerSessionRequest
* Represents the input for a request action.
* @return Result of the CreatePlayerSession operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidGameSessionStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the game instance. Clients should not retry such requests without resolving the conflict.
* @throws GameSessionFullException
* The game instance is currently full and cannot allow the requested player(s) to join. This exception
* occurs in response to a CreatePlayerSession request.
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @sample AmazonGameLift.CreatePlayerSession
*/
CreatePlayerSessionResult createPlayerSession(CreatePlayerSessionRequest createPlayerSessionRequest);
/**
*
* 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.
*
*
* @param createPlayerSessionsRequest
* Represents the input for a request action.
* @return Result of the CreatePlayerSessions operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidGameSessionStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the game instance. Clients should not retry such requests without resolving the conflict.
* @throws GameSessionFullException
* The game instance is currently full and cannot allow the requested player(s) to join. This exception
* occurs in response to a CreatePlayerSession request.
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @sample AmazonGameLift.CreatePlayerSessions
*/
CreatePlayerSessionsResult createPlayerSessions(CreatePlayerSessionsRequest createPlayerSessionsRequest);
/**
*
* 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.
*
*
* @param deleteAliasRequest
* Represents the input for a request action.
* @return Result of the DeleteAlias operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.DeleteAlias
*/
DeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest);
/**
*
* 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.
*
*
* @param deleteBuildRequest
* Represents the input for a request action.
* @return Result of the DeleteBuild operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @sample AmazonGameLift.DeleteBuild
*/
DeleteBuildResult deleteBuild(DeleteBuildRequest deleteBuildRequest);
/**
*
* 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.
*
*
* @param deleteFleetRequest
* Represents the input for a request action.
* @return Result of the DeleteFleet operation returned by the service.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidFleetStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the fleet. Resolve the conflict before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @sample AmazonGameLift.DeleteFleet
*/
DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest);
/**
*
* 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.
*
*
* @param deleteScalingPolicyRequest
* Represents the input for a request action.
* @return Result of the DeleteScalingPolicy operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @sample AmazonGameLift.DeleteScalingPolicy
*/
DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest);
/**
*
* Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias
* object is returned.
*
*
* @param describeAliasRequest
* Represents the input for a request action.
* @return Result of the DescribeAlias operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.DescribeAlias
*/
DescribeAliasResult describeAlias(DescribeAliasRequest describeAliasRequest);
/**
*
* Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing
* the build properties is returned.
*
*
* @param describeBuildRequest
* Represents the input for a request action.
* @return Result of the DescribeBuild operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.DescribeBuild
*/
DescribeBuildResult describeBuild(DescribeBuildRequest describeBuildRequest);
/**
*
* 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).
*
*
* @param describeEC2InstanceLimitsRequest
* Represents the input for a request action.
* @return Result of the DescribeEC2InstanceLimits operation returned by the service.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.DescribeEC2InstanceLimits
*/
DescribeEC2InstanceLimitsResult describeEC2InstanceLimits(DescribeEC2InstanceLimitsRequest describeEC2InstanceLimitsRequest);
/**
*
* 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.
*
*
*
* @param describeFleetAttributesRequest
* Represents the input for a request action.
* @return Result of the DescribeFleetAttributes operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.DescribeFleetAttributes
*/
DescribeFleetAttributesResult describeFleetAttributes(DescribeFleetAttributesRequest describeFleetAttributesRequest);
/**
*
* 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.
*
*
*
* @param describeFleetCapacityRequest
* Represents the input for a request action.
* @return Result of the DescribeFleetCapacity operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.DescribeFleetCapacity
*/
DescribeFleetCapacityResult describeFleetCapacity(DescribeFleetCapacityRequest describeFleetCapacityRequest);
/**
*
* 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.
*
*
* @param describeFleetEventsRequest
* Represents the input for a request action.
* @return Result of the DescribeFleetEvents operation returned by the service.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @sample AmazonGameLift.DescribeFleetEvents
*/
DescribeFleetEventsResult describeFleetEvents(DescribeFleetEventsRequest describeFleetEventsRequest);
/**
*
* 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.
*
*
* @param describeFleetPortSettingsRequest
* Represents the input for a request action.
* @return Result of the DescribeFleetPortSettings operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.DescribeFleetPortSettings
*/
DescribeFleetPortSettingsResult describeFleetPortSettings(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest);
/**
*
* 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.
*
*
*
* @param describeFleetUtilizationRequest
* Represents the input for a request action.
* @return Result of the DescribeFleetUtilization operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.DescribeFleetUtilization
*/
DescribeFleetUtilizationResult describeFleetUtilization(DescribeFleetUtilizationRequest describeFleetUtilizationRequest);
/**
*
* 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.
*
*
* @param describeGameSessionDetailsRequest
* Represents the input for a request action.
* @return Result of the DescribeGameSessionDetails operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @sample AmazonGameLift.DescribeGameSessionDetails
*/
DescribeGameSessionDetailsResult describeGameSessionDetails(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest);
/**
*
* 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.
*
*
* @param describeGameSessionsRequest
* Represents the input for a request action.
* @return Result of the DescribeGameSessions operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @sample AmazonGameLift.DescribeGameSessions
*/
DescribeGameSessionsResult describeGameSessions(DescribeGameSessionsRequest describeGameSessionsRequest);
/**
*
* 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.
*
*
* @param describePlayerSessionsRequest
* Represents the input for a request action.
* @return Result of the DescribePlayerSessions operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.DescribePlayerSessions
*/
DescribePlayerSessionsResult describePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest);
/**
*
* Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how
* to launch server processes on instances in the fleet.
*
*
* @param describeRuntimeConfigurationRequest
* Represents the input for a request action.
* @return Result of the DescribeRuntimeConfiguration operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @sample AmazonGameLift.DescribeRuntimeConfiguration
*/
DescribeRuntimeConfigurationResult describeRuntimeConfiguration(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest);
/**
*
* 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.
*
*
* @param describeScalingPoliciesRequest
* Represents the input for a request action.
* @return Result of the DescribeScalingPolicies operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @sample AmazonGameLift.DescribeScalingPolicies
*/
DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest);
/**
*
* 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.
*
*
*
* @param getGameSessionLogUrlRequest
* Represents the input for a request action.
* @return Result of the GetGameSessionLogUrl operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @sample AmazonGameLift.GetGameSessionLogUrl
*/
GetGameSessionLogUrlResult getGameSessionLogUrl(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest);
/**
*
* 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.
*
*
*
* @param listAliasesRequest
* Represents the input for a request action.
* @return Result of the ListAliases operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.ListAliases
*/
ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest);
/**
*
* 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.
*
*
*
* @param listBuildsRequest
* Represents the input for a request action.
* @return Result of the ListBuilds operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.ListBuilds
*/
ListBuildsResult listBuilds(ListBuildsRequest listBuildsRequest);
/**
*
* 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.
*
*
*
* @param listFleetsRequest
* Represents the input for a request action.
* @return Result of the ListFleets operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.ListFleets
*/
ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest);
/**
*
* 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 [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.
*
*
* @param putScalingPolicyRequest
* Represents the input for a request action.
* @return Result of the PutScalingPolicy operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @sample AmazonGameLift.PutScalingPolicy
*/
PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest);
/**
*
* 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 status of that build changes to READY.
* Once this happens, you must create a brand new build.
*
*
* @param requestUploadCredentialsRequest
* Represents the input for a request action.
* @return Result of the RequestUploadCredentials operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.RequestUploadCredentials
*/
RequestUploadCredentialsResult requestUploadCredentials(RequestUploadCredentialsRequest requestUploadCredentialsRequest);
/**
*
* Retrieves the fleet ID that a specified alias is currently pointing to.
*
*
* @param resolveAliasRequest
* Represents the input for a request action.
* @return Result of the ResolveAlias operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.ResolveAlias
*/
ResolveAliasResult resolveAlias(ResolveAliasRequest resolveAliasRequest);
/**
*
* Retrieves a list of game sessions in a fleet that match a set of search criteria and sorts them in a specified
* order. Currently game session searches are limited to a single fleet. Search results include only game sessions
* that are in ACTIVE status.
*
*
* You can search or sort by the following game session attributes:
*
*
* - gameSessionId -- ID value assigned to a game session. This unique value is returned in a
* GameSession object when a new game session is created.
* - gameSessionName -- Name assigned to a game session. This value is set when requesting a new game
* session with CreateGameSession or updating with UpdateGameSession. Game session names do not need
* to be unique to a game session.
* - creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time
* as milliseconds.
* - playerSessionCount -- Number of players currently connected to a game session. This value changes
* rapidly as players join the session or drop out.
* - maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set
* when requesting a new game session with CreateGameSession or updating with UpdateGameSession.
* - hasAvailablePlayerSessions -- Boolean value indicating whether or not a game session has reached its
* maximum number of players. When searching with this attribute, the search value must be
true or
* false. It is highly recommended that all search requests include this filter attribute to optimize
* search performance and return only sessions that players can join.
*
*
* To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort
* expression, or both. 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 playerSessionCount and hasAvailablePlayerSessions change quickly as
* players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh
* search results often, and handle sessions that fill up before a player can join.
*
*
*
* @param searchGameSessionsRequest
* Represents the input for a request action.
* @return Result of the SearchGameSessions operation returned by the service.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws TerminalRoutingStrategyException
* The service is unable to resolve the routing for a particular alias because it has a terminal
* RoutingStrategy associated with it. The message returned in this exception is the message defined
* in the routing strategy itself. Such requests should only be retried if the routing strategy for the
* specified alias is modified.
* @sample AmazonGameLift.SearchGameSessions
*/
SearchGameSessionsResult searchGameSessions(SearchGameSessionsRequest searchGameSessionsRequest);
/**
*
* 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.
*
*
* @param updateAliasRequest
* Represents the input for a request action.
* @return Result of the UpdateAlias operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.UpdateAlias
*/
UpdateAliasResult updateAlias(UpdateAliasRequest updateAliasRequest);
/**
*
* 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.
*
*
* @param updateBuildRequest
* Represents the input for a request action.
* @return Result of the UpdateBuild operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @sample AmazonGameLift.UpdateBuild
*/
UpdateBuildResult updateBuild(UpdateBuildRequest updateBuildRequest);
/**
*
* 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.
*
*
* @param updateFleetAttributesRequest
* Represents the input for a request action.
* @return Result of the UpdateFleetAttributes operation returned by the service.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws InvalidFleetStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the fleet. Resolve the conflict before retrying.
* @throws LimitExceededException
* The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue
* before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.UpdateFleetAttributes
*/
UpdateFleetAttributesResult updateFleetAttributes(UpdateFleetAttributesRequest updateFleetAttributesRequest);
/**
*
* 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.
*
*
* @param updateFleetCapacityRequest
* Represents the input for a request action.
* @return Result of the UpdateFleetCapacity operation returned by the service.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws LimitExceededException
* The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue
* before retrying.
* @throws InvalidFleetStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the fleet. Resolve the conflict before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.UpdateFleetCapacity
*/
UpdateFleetCapacityResult updateFleetCapacity(UpdateFleetCapacityRequest updateFleetCapacityRequest);
/**
*
* 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.
*
*
* @param updateFleetPortSettingsRequest
* Represents the input for a request action.
* @return Result of the UpdateFleetPortSettings operation returned by the service.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws InvalidFleetStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the fleet. Resolve the conflict before retrying.
* @throws LimitExceededException
* The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue
* before retrying.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @sample AmazonGameLift.UpdateFleetPortSettings
*/
UpdateFleetPortSettingsResult updateFleetPortSettings(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest);
/**
*
* 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.
*
*
* @param updateGameSessionRequest
* Represents the input for a request action.
* @return Result of the UpdateGameSession operation returned by the service.
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws ConflictException
* The requested operation would cause a conflict with the current state of a service resource associated
* with the request. Resolve the conflict before retrying this request.
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws InvalidGameSessionStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the game instance. Clients should not retry such requests without resolving the conflict.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @sample AmazonGameLift.UpdateGameSession
*/
UpdateGameSessionResult updateGameSession(UpdateGameSessionRequest updateGameSessionRequest);
/**
*
* 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 RuntimeConfiguration object with
* the updated collection of server process configurations.
*
*
* 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.
*
*
* @param updateRuntimeConfigurationRequest
* Represents the input for a request action.
* @return Result of the UpdateRuntimeConfiguration operation returned by the service.
* @throws UnauthorizedException
* The client failed authentication. Clients should not retry such requests
* @throws NotFoundException
* A service resource associated with the request could not be found. Clients should not retry such requests
* @throws InternalServiceException
* The service encountered an unrecoverable internal failure while processing the request. Clients can retry
* such requests, either immediately or after a back-off period.
* @throws InvalidRequestException
* One or more parameters specified as part of the request are invalid. Correct the invalid parameters
* before retrying.
* @throws InvalidFleetStatusException
* The requested operation would cause a conflict with the current state of a resource associated with the
* request and/or the fleet. Resolve the conflict before retrying.
* @sample AmazonGameLift.UpdateRuntimeConfiguration
*/
UpdateRuntimeConfigurationResult updateRuntimeConfiguration(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}