@ThreadSafe public class AmazonGameLiftClient extends AmazonWebServiceClient implements AmazonGameLift
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
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.
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.
To view changes to the API, see the GameLift Document History page.
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonGameLiftClient()
Constructs a new client to invoke service methods on Amazon GameLift.
|
AmazonGameLiftClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon GameLift
using the specified AWS account credentials.
|
AmazonGameLiftClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon GameLift
using the specified AWS account credentials and client configuration
options.
|
AmazonGameLiftClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon GameLift
using the specified AWS account credentials provider.
|
AmazonGameLiftClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon GameLift
using the specified AWS account credentials provider and client
configuration options.
|
AmazonGameLiftClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon GameLift
using the specified AWS account credentials provider, client
configuration options, and request metric collector.
|
AmazonGameLiftClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon GameLift.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAliasResult |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a fleet.
|
CreateBuildResult |
createBuild(CreateBuildRequest createBuildRequest)
Initializes a new build record and generates information required to
upload a game build to Amazon GameLift.
|
CreateFleetResult |
createFleet(CreateFleetRequest createFleetRequest)
Creates a new fleet to run your game servers.
|
CreateGameSessionResult |
createGameSession(CreateGameSessionRequest createGameSessionRequest)
Creates a multiplayer game session for players.
|
CreatePlayerSessionResult |
createPlayerSession(CreatePlayerSessionRequest createPlayerSessionRequest)
Adds a player to a game session and creates a player session record.
|
CreatePlayerSessionsResult |
createPlayerSessions(CreatePlayerSessionsRequest createPlayerSessionsRequest)
Adds a group of players to a game session.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes an alias.
|
DeleteBuildResult |
deleteBuild(DeleteBuildRequest deleteBuildRequest)
Deletes a build.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes everything related to a fleet.
|
DeleteScalingPolicyResult |
deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)
Deletes a fleet scaling policy.
|
DescribeAliasResult |
describeAlias(DescribeAliasRequest describeAliasRequest)
Retrieves properties for a specified alias.
|
DescribeBuildResult |
describeBuild(DescribeBuildRequest describeBuildRequest)
Retrieves properties for a build.
|
DescribeEC2InstanceLimitsResult |
describeEC2InstanceLimits(DescribeEC2InstanceLimitsRequest describeEC2InstanceLimitsRequest)
Retrieves the following information for the specified EC2 instance type:
|
DescribeFleetAttributesResult |
describeFleetAttributes(DescribeFleetAttributesRequest describeFleetAttributesRequest)
Retrieves fleet properties, including metadata, status, and
configuration, for one or more fleets.
|
DescribeFleetCapacityResult |
describeFleetCapacity(DescribeFleetCapacityRequest describeFleetCapacityRequest)
Retrieves the current status of fleet capacity for one or more fleets.
|
DescribeFleetEventsResult |
describeFleetEvents(DescribeFleetEventsRequest describeFleetEventsRequest)
Retrieves entries from the specified fleet's event log.
|
DescribeFleetPortSettingsResult |
describeFleetPortSettings(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest)
Retrieves the inbound connection permissions for a fleet.
|
DescribeFleetUtilizationResult |
describeFleetUtilization(DescribeFleetUtilizationRequest describeFleetUtilizationRequest)
Retrieves utilization statistics for one or more fleets.
|
DescribeGameSessionDetailsResult |
describeGameSessionDetails(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest)
Retrieves properties, including the protection policy in force, for one
or more game sessions.
|
DescribeGameSessionsResult |
describeGameSessions(DescribeGameSessionsRequest describeGameSessionsRequest)
Retrieves properties for one or more game sessions.
|
DescribePlayerSessionsResult |
describePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)
Retrieves properties for one or more player sessions.
|
DescribeRuntimeConfigurationResult |
describeRuntimeConfiguration(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest)
Retrieves the current runtime configuration for the specified fleet.
|
DescribeScalingPoliciesResult |
describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
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 getGameSessionLogUrlRequest)
Retrieves the location of stored game session logs for a specified game
session.
|
ListAliasesResult |
listAliases(ListAliasesRequest listAliasesRequest)
Retrieves a collection of alias records for this AWS account.
|
ListBuildsResult |
listBuilds(ListBuildsRequest listBuildsRequest)
Retrieves build records for all builds associated with the AWS account in
use.
|
ListFleetsResult |
listFleets(ListFleetsRequest listFleetsRequest)
Retrieves a collection of fleet records for this AWS account.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a scaling policy for a fleet.
|
RequestUploadCredentialsResult |
requestUploadCredentials(RequestUploadCredentialsRequest requestUploadCredentialsRequest)
Retrieves a fresh set of upload credentials and the assigned Amazon S3
storage location for a specific build.
|
ResolveAliasResult |
resolveAlias(ResolveAliasRequest resolveAliasRequest)
Retrieves the fleet ID that a specified alias is currently pointing to.
|
SearchGameSessionsResult |
searchGameSessions(SearchGameSessionsRequest searchGameSessionsRequest)
Retrieves a list of game sessions in a fleet that match a set of search
criteria and sorts them in a specified order.
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest updateAliasRequest)
Updates properties for an alias.
|
UpdateBuildResult |
updateBuild(UpdateBuildRequest updateBuildRequest)
Updates metadata in a build record, including the build name and version.
|
UpdateFleetAttributesResult |
updateFleetAttributes(UpdateFleetAttributesRequest updateFleetAttributesRequest)
Updates fleet properties, including name and description, for a fleet.
|
UpdateFleetCapacityResult |
updateFleetCapacity(UpdateFleetCapacityRequest updateFleetCapacityRequest)
Updates capacity settings for a fleet.
|
UpdateFleetPortSettingsResult |
updateFleetPortSettings(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest)
Updates port settings for a fleet.
|
UpdateGameSessionResult |
updateGameSession(UpdateGameSessionRequest updateGameSessionRequest)
Updates game session properties.
|
UpdateRuntimeConfigurationResult |
updateRuntimeConfiguration(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest)
Updates the current runtime configuration for the specified fleet, which
tells GameLift how to launch server processes on instances in the fleet.
|
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected static final ClientConfigurationFactory configFactory
public AmazonGameLiftClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonGameLiftClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client
connects to Amazon GameLift (ex: proxy settings, retry counts,
etc.).DefaultAWSCredentialsProviderChainpublic AmazonGameLiftClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonGameLiftClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to Amazon GameLift (ex: proxy settings, retry counts,
etc.).public AmazonGameLiftClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonGameLiftClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to Amazon GameLift (ex: proxy settings, retry counts,
etc.).public AmazonGameLiftClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to Amazon GameLift (ex: proxy settings, retry counts,
etc.).requestMetricCollector - optional request metric collectorpublic CreateAliasResult createAlias(CreateAliasRequest createAliasRequest)
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.
createAlias in interface AmazonGameLiftcreateAliasRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.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.LimitExceededException - The requested operation would cause the resource to exceed the
allowed service limit. Resolve the issue before retrying.public CreateBuildResult createBuild(CreateBuildRequest createBuildRequest)
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 for more details on the CLI and the upload
process.)
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 (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.
createBuild in interface AmazonGameLiftcreateBuildRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.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.public CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
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:
NEW
(followed by other statuses as the fleet is activated).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:
createFleet in interface AmazonGameLiftcreateFleetRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsConflictException - 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.LimitExceededException - The requested operation would cause the resource to exceed the
allowed service limit. Resolve the issue before retrying.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic CreateGameSessionResult createGameSession(CreateGameSessionRequest createGameSessionRequest)
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.
createGameSession in interface AmazonGameLiftcreateGameSessionRequest - Represents the input for a request action.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.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.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidFleetStatusException - 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.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsFleetCapacityExceededException - 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.public CreatePlayerSessionResult createPlayerSession(CreatePlayerSessionRequest createPlayerSessionRequest)
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.
createPlayerSession in interface AmazonGameLiftcreatePlayerSessionRequest - Represents the input for a request action.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.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidGameSessionStatusException - 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.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.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestspublic CreatePlayerSessionsResult createPlayerSessions(CreatePlayerSessionsRequest createPlayerSessionsRequest)
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.
createPlayerSessions in interface AmazonGameLiftcreatePlayerSessionsRequest - Represents the input for a request action.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.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidGameSessionStatusException - 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.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.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestspublic DeleteAliasResult deleteAlias(DeleteAliasRequest deleteAliasRequest)
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.
deleteAlias in interface AmazonGameLiftdeleteAliasRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.public DeleteBuildResult deleteBuild(DeleteBuildRequest deleteBuildRequest)
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.
deleteBuild in interface AmazonGameLiftdeleteBuildRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.public DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
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.
deleteFleet in interface AmazonGameLiftdeleteFleetRequest - Represents the input for a request action.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.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.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.public DeleteScalingPolicyResult deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)
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.
deleteScalingPolicy in interface AmazonGameLiftdeleteScalingPolicyRequest - Represents the input for a request action.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestspublic DescribeAliasResult describeAlias(DescribeAliasRequest describeAliasRequest)
Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
describeAlias in interface AmazonGameLiftdescribeAliasRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.public DescribeBuildResult describeBuild(DescribeBuildRequest describeBuildRequest)
Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
describeBuild in interface AmazonGameLiftdescribeBuildRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.public DescribeEC2InstanceLimitsResult describeEC2InstanceLimits(DescribeEC2InstanceLimitsRequest describeEC2InstanceLimitsRequest)
Retrieves the following information for the specified EC2 instance type:
Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).
describeEC2InstanceLimits in interface AmazonGameLiftdescribeEC2InstanceLimitsRequest - Represents the input for a request action.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic DescribeFleetAttributesResult describeFleetAttributes(DescribeFleetAttributesRequest describeFleetAttributesRequest)
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.
describeFleetAttributes in interface AmazonGameLiftdescribeFleetAttributesRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic DescribeFleetCapacityResult describeFleetCapacity(DescribeFleetCapacityRequest describeFleetCapacityRequest)
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.
describeFleetCapacity in interface AmazonGameLiftdescribeFleetCapacityRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic DescribeFleetEventsResult describeFleetEvents(DescribeFleetEventsRequest describeFleetEventsRequest)
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.
describeFleetEvents in interface AmazonGameLiftdescribeFleetEventsRequest - Represents the input for a request action.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.public DescribeFleetPortSettingsResult describeFleetPortSettings(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest)
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.
describeFleetPortSettings in interface AmazonGameLiftdescribeFleetPortSettingsRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic DescribeFleetUtilizationResult describeFleetUtilization(DescribeFleetUtilizationRequest describeFleetUtilizationRequest)
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.
describeFleetUtilization in interface AmazonGameLiftdescribeFleetUtilizationRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic DescribeGameSessionDetailsResult describeGameSessionDetails(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest)
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.
describeGameSessionDetails in interface AmazonGameLiftdescribeGameSessionDetailsRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsTerminalRoutingStrategyException - 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.public DescribeGameSessionsResult describeGameSessions(DescribeGameSessionsRequest describeGameSessionsRequest)
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.
describeGameSessions in interface AmazonGameLiftdescribeGameSessionsRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsTerminalRoutingStrategyException - 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.public DescribePlayerSessionsResult describePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)
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.
describePlayerSessions in interface AmazonGameLiftdescribePlayerSessionsRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic DescribeRuntimeConfigurationResult describeRuntimeConfiguration(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest)
Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.
describeRuntimeConfiguration in interface AmazonGameLiftdescribeRuntimeConfigurationRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.public DescribeScalingPoliciesResult describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
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.
describeScalingPolicies in interface AmazonGameLiftdescribeScalingPoliciesRequest - Represents the input for a request action.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestspublic GetGameSessionLogUrlResult getGameSessionLogUrl(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest)
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.
getGameSessionLogUrl in interface AmazonGameLiftgetGameSessionLogUrlRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsUnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.public ListAliasesResult listAliases(ListAliasesRequest listAliasesRequest)
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.
listAliases in interface AmazonGameLiftlistAliasesRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.public ListBuildsResult listBuilds(ListBuildsRequest listBuildsRequest)
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.
listBuilds in interface AmazonGameLiftlistBuildsRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.public ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest)
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.
listFleets in interface AmazonGameLiftlistFleetsRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
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.
putScalingPolicy in interface AmazonGameLiftputScalingPolicyRequest - Represents the input for a request action.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestspublic RequestUploadCredentialsResult requestUploadCredentials(RequestUploadCredentialsRequest requestUploadCredentialsRequest)
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.
requestUploadCredentials in interface AmazonGameLiftrequestUploadCredentialsRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.public ResolveAliasResult resolveAlias(ResolveAliasRequest resolveAliasRequest)
Retrieves the fleet ID that a specified alias is currently pointing to.
resolveAlias in interface AmazonGameLiftresolveAliasRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsTerminalRoutingStrategyException - 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.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.public SearchGameSessionsResult searchGameSessions(SearchGameSessionsRequest searchGameSessionsRequest)
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:
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.
searchGameSessions in interface AmazonGameLiftsearchGameSessionsRequest - Represents the input for a request action.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.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsTerminalRoutingStrategyException - 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.public UpdateAliasResult updateAlias(UpdateAliasRequest updateAliasRequest)
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.
updateAlias in interface AmazonGameLiftupdateAliasRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.public UpdateBuildResult updateBuild(UpdateBuildRequest updateBuildRequest)
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.
updateBuild in interface AmazonGameLiftupdateBuildRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.public UpdateFleetAttributesResult updateFleetAttributes(UpdateFleetAttributesRequest updateFleetAttributesRequest)
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.
updateFleetAttributes in interface AmazonGameLiftupdateFleetAttributesRequest - Represents the input for a request action.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsConflictException - 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.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.LimitExceededException - The requested operation would cause the resource to exceed the
allowed service limit. Resolve the issue before retrying.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic UpdateFleetCapacityResult updateFleetCapacity(UpdateFleetCapacityRequest updateFleetCapacityRequest)
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.
updateFleetCapacity in interface AmazonGameLiftupdateFleetCapacityRequest - Represents the input for a request action.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsConflictException - 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.LimitExceededException - The requested operation would cause the resource to exceed the
allowed service limit. Resolve the issue before retrying.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.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic UpdateFleetPortSettingsResult updateFleetPortSettings(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest)
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.
updateFleetPortSettings in interface AmazonGameLiftupdateFleetPortSettingsRequest - Represents the input for a request action.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsConflictException - 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.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.LimitExceededException - The requested operation would cause the resource to exceed the
allowed service limit. Resolve the issue before retrying.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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.UnauthorizedException - The client failed authentication. Clients should not retry such
requestspublic UpdateGameSessionResult updateGameSession(UpdateGameSessionRequest updateGameSessionRequest)
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.
updateGameSession in interface AmazonGameLiftupdateGameSessionRequest - Represents the input for a request action.NotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsConflictException - 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.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.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsInvalidGameSessionStatusException - 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.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.public UpdateRuntimeConfigurationResult updateRuntimeConfiguration(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest)
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.
updateRuntimeConfiguration in interface AmazonGameLiftupdateRuntimeConfigurationRequest - Represents the input for a request action.UnauthorizedException - The client failed authentication. Clients should not retry such
requestsNotFoundException - A service resource associated with the request could not be
found. Clients should not retry such requestsInternalServiceException - The service encountered an unrecoverable internal failure while
processing the request. Clients can retry such requests, either
immediately or after a back-off period.InvalidRequestException - One or more parameters specified as part of the request are
invalid. Correct the invalid parameters before retrying.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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AmazonGameLiftrequest - The originally executed requestCopyright © 2016. All rights reserved.