Interface GameLiftAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.
About Amazon GameLift solutions
Get more information on these Amazon GameLift solutions in the Amazon GameLift Developer Guide.
-
Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.
-
Managed hosting with Realtime Servers -- With Amazon GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core Amazon GameLift infrastructure already built in. Then use the full range of Amazon GameLift managed hosting features, including FlexMatch, for your game.
-
Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. Amazon GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services.
-
Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.
About this API Reference
This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<AcceptMatchResponse> acceptMatch
(Consumer<AcceptMatchRequest.Builder> acceptMatchRequest) Registers a player's acceptance or rejection of a proposed FlexMatch match.default CompletableFuture
<AcceptMatchResponse> acceptMatch
(AcceptMatchRequest acceptMatchRequest) Registers a player's acceptance or rejection of a proposed FlexMatch match.static GameLiftAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aGameLiftAsyncClient
.default CompletableFuture
<ClaimGameServerResponse> claimGameServer
(Consumer<ClaimGameServerRequest.Builder> claimGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.default CompletableFuture
<ClaimGameServerResponse> claimGameServer
(ClaimGameServerRequest claimGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.static GameLiftAsyncClient
create()
Create aGameLiftAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAliasResponse> createAlias
(Consumer<CreateAliasRequest.Builder> createAliasRequest) Creates an alias for a fleet.default CompletableFuture
<CreateAliasResponse> createAlias
(CreateAliasRequest createAliasRequest) Creates an alias for a fleet.default CompletableFuture
<CreateBuildResponse> createBuild
(Consumer<CreateBuildRequest.Builder> createBuildRequest) Creates a new Amazon GameLift build resource for your game server binary files.default CompletableFuture
<CreateBuildResponse> createBuild
(CreateBuildRequest createBuildRequest) Creates a new Amazon GameLift build resource for your game server binary files.createContainerGroupDefinition
(Consumer<CreateContainerGroupDefinitionRequest.Builder> createContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.createContainerGroupDefinition
(CreateContainerGroupDefinitionRequest createContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<CreateFleetResponse> createFleet
(Consumer<CreateFleetRequest.Builder> createFleetRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<CreateFleetResponse> createFleet
(CreateFleetRequest createFleetRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.createFleetLocations
(Consumer<CreateFleetLocationsRequest.Builder> createFleetLocationsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.createFleetLocations
(CreateFleetLocationsRequest createFleetLocationsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.createGameServerGroup
(Consumer<CreateGameServerGroupRequest.Builder> createGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.createGameServerGroup
(CreateGameServerGroupRequest createGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.createGameSession
(Consumer<CreateGameSessionRequest.Builder> createGameSessionRequest) Creates a multiplayer game session for players in a specific fleet location.createGameSession
(CreateGameSessionRequest createGameSessionRequest) Creates a multiplayer game session for players in a specific fleet location.createGameSessionQueue
(Consumer<CreateGameSessionQueueRequest.Builder> createGameSessionQueueRequest) Creates a placement queue that processes requests for new game sessions.createGameSessionQueue
(CreateGameSessionQueueRequest createGameSessionQueueRequest) Creates a placement queue that processes requests for new game sessions.default CompletableFuture
<CreateLocationResponse> createLocation
(Consumer<CreateLocationRequest.Builder> createLocationRequest) Creates a custom location for use in an Anywhere fleet.default CompletableFuture
<CreateLocationResponse> createLocation
(CreateLocationRequest createLocationRequest) Creates a custom location for use in an Anywhere fleet.createMatchmakingConfiguration
(Consumer<CreateMatchmakingConfigurationRequest.Builder> createMatchmakingConfigurationRequest) Defines a new matchmaking configuration for use with FlexMatch.createMatchmakingConfiguration
(CreateMatchmakingConfigurationRequest createMatchmakingConfigurationRequest) Defines a new matchmaking configuration for use with FlexMatch.createMatchmakingRuleSet
(Consumer<CreateMatchmakingRuleSetRequest.Builder> createMatchmakingRuleSetRequest) Creates a new rule set for FlexMatch matchmaking.createMatchmakingRuleSet
(CreateMatchmakingRuleSetRequest createMatchmakingRuleSetRequest) Creates a new rule set for FlexMatch matchmaking.createPlayerSession
(Consumer<CreatePlayerSessionRequest.Builder> createPlayerSessionRequest) Reserves an open player slot in a game session for a player.createPlayerSession
(CreatePlayerSessionRequest createPlayerSessionRequest) Reserves an open player slot in a game session for a player.createPlayerSessions
(Consumer<CreatePlayerSessionsRequest.Builder> createPlayerSessionsRequest) Reserves open slots in a game session for a group of players.createPlayerSessions
(CreatePlayerSessionsRequest createPlayerSessionsRequest) Reserves open slots in a game session for a group of players.default CompletableFuture
<CreateScriptResponse> createScript
(Consumer<CreateScriptRequest.Builder> createScriptRequest) Creates a new script record for your Realtime Servers script.default CompletableFuture
<CreateScriptResponse> createScript
(CreateScriptRequest createScriptRequest) Creates a new script record for your Realtime Servers script.createVpcPeeringAuthorization
(Consumer<CreateVpcPeeringAuthorizationRequest.Builder> createVpcPeeringAuthorizationRequest) Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account.createVpcPeeringAuthorization
(CreateVpcPeeringAuthorizationRequest createVpcPeeringAuthorizationRequest) Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account.createVpcPeeringConnection
(Consumer<CreateVpcPeeringConnectionRequest.Builder> createVpcPeeringConnectionRequest) Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet.createVpcPeeringConnection
(CreateVpcPeeringConnectionRequest createVpcPeeringConnectionRequest) Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet.default CompletableFuture
<DeleteAliasResponse> deleteAlias
(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) Deletes an alias.default CompletableFuture
<DeleteAliasResponse> deleteAlias
(DeleteAliasRequest deleteAliasRequest) Deletes an alias.default CompletableFuture
<DeleteBuildResponse> deleteBuild
(Consumer<DeleteBuildRequest.Builder> deleteBuildRequest) Deletes a build.default CompletableFuture
<DeleteBuildResponse> deleteBuild
(DeleteBuildRequest deleteBuildRequest) Deletes a build.deleteContainerGroupDefinition
(Consumer<DeleteContainerGroupDefinitionRequest.Builder> deleteContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.deleteContainerGroupDefinition
(DeleteContainerGroupDefinitionRequest deleteContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<DeleteFleetResponse> deleteFleet
(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest) Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.default CompletableFuture
<DeleteFleetResponse> deleteFleet
(DeleteFleetRequest deleteFleetRequest) Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.deleteFleetLocations
(Consumer<DeleteFleetLocationsRequest.Builder> deleteFleetLocationsRequest) Removes locations from a multi-location fleet.deleteFleetLocations
(DeleteFleetLocationsRequest deleteFleetLocationsRequest) Removes locations from a multi-location fleet.deleteGameServerGroup
(Consumer<DeleteGameServerGroupRequest.Builder> deleteGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.deleteGameServerGroup
(DeleteGameServerGroupRequest deleteGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.deleteGameSessionQueue
(Consumer<DeleteGameSessionQueueRequest.Builder> deleteGameSessionQueueRequest) Deletes a game session queue.deleteGameSessionQueue
(DeleteGameSessionQueueRequest deleteGameSessionQueueRequest) Deletes a game session queue.default CompletableFuture
<DeleteLocationResponse> deleteLocation
(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest) Deletes a custom location.default CompletableFuture
<DeleteLocationResponse> deleteLocation
(DeleteLocationRequest deleteLocationRequest) Deletes a custom location.deleteMatchmakingConfiguration
(Consumer<DeleteMatchmakingConfigurationRequest.Builder> deleteMatchmakingConfigurationRequest) Permanently removes a FlexMatch matchmaking configuration.deleteMatchmakingConfiguration
(DeleteMatchmakingConfigurationRequest deleteMatchmakingConfigurationRequest) Permanently removes a FlexMatch matchmaking configuration.deleteMatchmakingRuleSet
(Consumer<DeleteMatchmakingRuleSetRequest.Builder> deleteMatchmakingRuleSetRequest) Deletes an existing matchmaking rule set.deleteMatchmakingRuleSet
(DeleteMatchmakingRuleSetRequest deleteMatchmakingRuleSetRequest) Deletes an existing matchmaking rule set.deleteScalingPolicy
(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest) Deletes a fleet scaling policy.deleteScalingPolicy
(DeleteScalingPolicyRequest deleteScalingPolicyRequest) Deletes a fleet scaling policy.default CompletableFuture
<DeleteScriptResponse> deleteScript
(Consumer<DeleteScriptRequest.Builder> deleteScriptRequest) Deletes a Realtime script.default CompletableFuture
<DeleteScriptResponse> deleteScript
(DeleteScriptRequest deleteScriptRequest) Deletes a Realtime script.deleteVpcPeeringAuthorization
(Consumer<DeleteVpcPeeringAuthorizationRequest.Builder> deleteVpcPeeringAuthorizationRequest) Cancels a pending VPC peering authorization for the specified VPC.deleteVpcPeeringAuthorization
(DeleteVpcPeeringAuthorizationRequest deleteVpcPeeringAuthorizationRequest) Cancels a pending VPC peering authorization for the specified VPC.deleteVpcPeeringConnection
(Consumer<DeleteVpcPeeringConnectionRequest.Builder> deleteVpcPeeringConnectionRequest) Removes a VPC peering connection.deleteVpcPeeringConnection
(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest) Removes a VPC peering connection.deregisterCompute
(Consumer<DeregisterComputeRequest.Builder> deregisterComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.deregisterCompute
(DeregisterComputeRequest deregisterComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.deregisterGameServer
(Consumer<DeregisterGameServerRequest.Builder> deregisterGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.deregisterGameServer
(DeregisterGameServerRequest deregisterGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.default CompletableFuture
<DescribeAliasResponse> describeAlias
(Consumer<DescribeAliasRequest.Builder> describeAliasRequest) Retrieves properties for an alias.default CompletableFuture
<DescribeAliasResponse> describeAlias
(DescribeAliasRequest describeAliasRequest) Retrieves properties for an alias.default CompletableFuture
<DescribeBuildResponse> describeBuild
(Consumer<DescribeBuildRequest.Builder> describeBuildRequest) Retrieves properties for a custom game build.default CompletableFuture
<DescribeBuildResponse> describeBuild
(DescribeBuildRequest describeBuildRequest) Retrieves properties for a custom game build.default CompletableFuture
<DescribeComputeResponse> describeCompute
(Consumer<DescribeComputeRequest.Builder> describeComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<DescribeComputeResponse> describeCompute
(DescribeComputeRequest describeComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.describeContainerGroupDefinition
(Consumer<DescribeContainerGroupDefinitionRequest.Builder> describeContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.describeContainerGroupDefinition
(DescribeContainerGroupDefinitionRequest describeContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.describeEC2InstanceLimits
(Consumer<DescribeEc2InstanceLimitsRequest.Builder> describeEc2InstanceLimitsRequest) Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.describeEC2InstanceLimits
(DescribeEc2InstanceLimitsRequest describeEc2InstanceLimitsRequest) Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.describeFleetAttributes
(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.describeFleetAttributes
(DescribeFleetAttributesRequest describeFleetAttributesRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default DescribeFleetAttributesPublisher
This is a variant ofdescribeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation.default DescribeFleetAttributesPublisher
describeFleetAttributesPaginator
(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest) This is a variant ofdescribeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation.default DescribeFleetAttributesPublisher
describeFleetAttributesPaginator
(DescribeFleetAttributesRequest describeFleetAttributesRequest) This is a variant ofdescribeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation.This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.describeFleetCapacity
(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.describeFleetCapacity
(DescribeFleetCapacityRequest describeFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default DescribeFleetCapacityPublisher
This is a variant ofdescribeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation.default DescribeFleetCapacityPublisher
describeFleetCapacityPaginator
(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest) This is a variant ofdescribeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation.default DescribeFleetCapacityPublisher
describeFleetCapacityPaginator
(DescribeFleetCapacityRequest describeFleetCapacityRequest) This is a variant ofdescribeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation.describeFleetEvents
(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest) Retrieves entries from a fleet's event log.describeFleetEvents
(DescribeFleetEventsRequest describeFleetEventsRequest) Retrieves entries from a fleet's event log.default DescribeFleetEventsPublisher
describeFleetEventsPaginator
(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest) This is a variant ofdescribeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation.default DescribeFleetEventsPublisher
describeFleetEventsPaginator
(DescribeFleetEventsRequest describeFleetEventsRequest) This is a variant ofdescribeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation.describeFleetLocationAttributes
(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest) Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.describeFleetLocationAttributes
(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest) Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.describeFleetLocationAttributesPaginator
(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest) This is a variant ofdescribeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation.describeFleetLocationAttributesPaginator
(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest) This is a variant ofdescribeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation.describeFleetLocationCapacity
(Consumer<DescribeFleetLocationCapacityRequest.Builder> describeFleetLocationCapacityRequest) Retrieves the resource capacity settings for a fleet location.describeFleetLocationCapacity
(DescribeFleetLocationCapacityRequest describeFleetLocationCapacityRequest) Retrieves the resource capacity settings for a fleet location.describeFleetLocationUtilization
(Consumer<DescribeFleetLocationUtilizationRequest.Builder> describeFleetLocationUtilizationRequest) Retrieves current usage data for a fleet location.describeFleetLocationUtilization
(DescribeFleetLocationUtilizationRequest describeFleetLocationUtilizationRequest) Retrieves current usage data for a fleet location.describeFleetPortSettings
(Consumer<DescribeFleetPortSettingsRequest.Builder> describeFleetPortSettingsRequest) Retrieves a fleet's inbound connection permissions.describeFleetPortSettings
(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest) Retrieves a fleet's inbound connection permissions.Retrieves utilization statistics for one or more fleets.describeFleetUtilization
(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest) Retrieves utilization statistics for one or more fleets.describeFleetUtilization
(DescribeFleetUtilizationRequest describeFleetUtilizationRequest) Retrieves utilization statistics for one or more fleets.This is a variant ofdescribeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation.describeFleetUtilizationPaginator
(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest) This is a variant ofdescribeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation.describeFleetUtilizationPaginator
(DescribeFleetUtilizationRequest describeFleetUtilizationRequest) This is a variant ofdescribeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation.describeGameServer
(Consumer<DescribeGameServerRequest.Builder> describeGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.describeGameServer
(DescribeGameServerRequest describeGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.describeGameServerGroup
(Consumer<DescribeGameServerGroupRequest.Builder> describeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.describeGameServerGroup
(DescribeGameServerGroupRequest describeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.describeGameServerInstances
(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.describeGameServerInstances
(DescribeGameServerInstancesRequest describeGameServerInstancesRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.describeGameServerInstancesPaginator
(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest) This is a variant ofdescribeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation.describeGameServerInstancesPaginator
(DescribeGameServerInstancesRequest describeGameServerInstancesRequest) This is a variant ofdescribeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation.describeGameSessionDetails
(Consumer<DescribeGameSessionDetailsRequest.Builder> describeGameSessionDetailsRequest) Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location.describeGameSessionDetails
(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest) Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location.describeGameSessionDetailsPaginator
(Consumer<DescribeGameSessionDetailsRequest.Builder> describeGameSessionDetailsRequest) This is a variant ofdescribeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation.describeGameSessionDetailsPaginator
(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest) This is a variant ofdescribeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation.describeGameSessionPlacement
(Consumer<DescribeGameSessionPlacementRequest.Builder> describeGameSessionPlacementRequest) Retrieves information, including current status, about a game session placement request.describeGameSessionPlacement
(DescribeGameSessionPlacementRequest describeGameSessionPlacementRequest) Retrieves information, including current status, about a game session placement request.Retrieves the properties for one or more game session queues.describeGameSessionQueues
(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest) Retrieves the properties for one or more game session queues.describeGameSessionQueues
(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest) Retrieves the properties for one or more game session queues.This is a variant ofdescribeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation.describeGameSessionQueuesPaginator
(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest) This is a variant ofdescribeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation.describeGameSessionQueuesPaginator
(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest) This is a variant ofdescribeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation.describeGameSessions
(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest) Retrieves a set of one or more game sessions in a specific fleet location.describeGameSessions
(DescribeGameSessionsRequest describeGameSessionsRequest) Retrieves a set of one or more game sessions in a specific fleet location.default DescribeGameSessionsPublisher
describeGameSessionsPaginator
(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest) This is a variant ofdescribeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation.default DescribeGameSessionsPublisher
describeGameSessionsPaginator
(DescribeGameSessionsRequest describeGameSessionsRequest) This is a variant ofdescribeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation.describeInstances
(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status.describeInstances
(DescribeInstancesRequest describeInstancesRequest) Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status.default DescribeInstancesPublisher
describeInstancesPaginator
(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) This is a variant ofdescribeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest)
operation.default DescribeInstancesPublisher
describeInstancesPaginator
(DescribeInstancesRequest describeInstancesRequest) This is a variant ofdescribeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest)
operation.describeMatchmaking
(Consumer<DescribeMatchmakingRequest.Builder> describeMatchmakingRequest) Retrieves one or more matchmaking tickets.describeMatchmaking
(DescribeMatchmakingRequest describeMatchmakingRequest) Retrieves one or more matchmaking tickets.Retrieves the details of FlexMatch matchmaking configurations.describeMatchmakingConfigurations
(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest) Retrieves the details of FlexMatch matchmaking configurations.describeMatchmakingConfigurations
(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest) Retrieves the details of FlexMatch matchmaking configurations.This is a variant ofdescribeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation.describeMatchmakingConfigurationsPaginator
(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest) This is a variant ofdescribeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation.describeMatchmakingConfigurationsPaginator
(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest) This is a variant ofdescribeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation.Retrieves the details for FlexMatch matchmaking rule sets.describeMatchmakingRuleSets
(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest) Retrieves the details for FlexMatch matchmaking rule sets.describeMatchmakingRuleSets
(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest) Retrieves the details for FlexMatch matchmaking rule sets.This is a variant ofdescribeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation.describeMatchmakingRuleSetsPaginator
(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest) This is a variant ofdescribeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation.describeMatchmakingRuleSetsPaginator
(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest) This is a variant ofdescribeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation.describePlayerSessions
(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest) Retrieves properties for one or more player sessions.describePlayerSessions
(DescribePlayerSessionsRequest describePlayerSessionsRequest) Retrieves properties for one or more player sessions.default DescribePlayerSessionsPublisher
describePlayerSessionsPaginator
(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest) This is a variant ofdescribePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation.default DescribePlayerSessionsPublisher
describePlayerSessionsPaginator
(DescribePlayerSessionsRequest describePlayerSessionsRequest) This is a variant ofdescribePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation.describeRuntimeConfiguration
(Consumer<DescribeRuntimeConfigurationRequest.Builder> describeRuntimeConfigurationRequest) Retrieves a fleet's runtime configuration settings.describeRuntimeConfiguration
(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest) Retrieves a fleet's runtime configuration settings.describeScalingPolicies
(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) Retrieves all scaling policies applied to a fleet.describeScalingPolicies
(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) Retrieves all scaling policies applied to a fleet.default DescribeScalingPoliciesPublisher
describeScalingPoliciesPaginator
(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) This is a variant ofdescribeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation.default DescribeScalingPoliciesPublisher
describeScalingPoliciesPaginator
(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) This is a variant ofdescribeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation.default CompletableFuture
<DescribeScriptResponse> describeScript
(Consumer<DescribeScriptRequest.Builder> describeScriptRequest) Retrieves properties for a Realtime script.default CompletableFuture
<DescribeScriptResponse> describeScript
(DescribeScriptRequest describeScriptRequest) Retrieves properties for a Realtime script.Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.describeVpcPeeringAuthorizations
(Consumer<DescribeVpcPeeringAuthorizationsRequest.Builder> describeVpcPeeringAuthorizationsRequest) Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.describeVpcPeeringAuthorizations
(DescribeVpcPeeringAuthorizationsRequest describeVpcPeeringAuthorizationsRequest) Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.Retrieves information on VPC peering connections.describeVpcPeeringConnections
(Consumer<DescribeVpcPeeringConnectionsRequest.Builder> describeVpcPeeringConnectionsRequest) Retrieves information on VPC peering connections.describeVpcPeeringConnections
(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest) Retrieves information on VPC peering connections.getComputeAccess
(Consumer<GetComputeAccessRequest.Builder> getComputeAccessRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.getComputeAccess
(GetComputeAccessRequest getComputeAccessRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.getComputeAuthToken
(Consumer<GetComputeAuthTokenRequest.Builder> getComputeAuthTokenRequest) Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet.getComputeAuthToken
(GetComputeAuthTokenRequest getComputeAuthTokenRequest) Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet.getGameSessionLogUrl
(Consumer<GetGameSessionLogUrlRequest.Builder> getGameSessionLogUrlRequest) Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets.getGameSessionLogUrl
(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest) Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets.getInstanceAccess
(Consumer<GetInstanceAccessRequest.Builder> getInstanceAccessRequest) Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet.getInstanceAccess
(GetInstanceAccessRequest getInstanceAccessRequest) Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet.default CompletableFuture
<ListAliasesResponse> Retrieves all aliases for this Amazon Web Services account.default CompletableFuture
<ListAliasesResponse> listAliases
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) Retrieves all aliases for this Amazon Web Services account.default CompletableFuture
<ListAliasesResponse> listAliases
(ListAliasesRequest listAliasesRequest) Retrieves all aliases for this Amazon Web Services account.default ListAliasesPublisher
This is a variant oflistAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation.default ListAliasesPublisher
listAliasesPaginator
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation.default ListAliasesPublisher
listAliasesPaginator
(ListAliasesRequest listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation.default CompletableFuture
<ListBuildsResponse> Retrieves build resources for all builds associated with the Amazon Web Services account in use.default CompletableFuture
<ListBuildsResponse> listBuilds
(Consumer<ListBuildsRequest.Builder> listBuildsRequest) Retrieves build resources for all builds associated with the Amazon Web Services account in use.default CompletableFuture
<ListBuildsResponse> listBuilds
(ListBuildsRequest listBuildsRequest) Retrieves build resources for all builds associated with the Amazon Web Services account in use.default ListBuildsPublisher
This is a variant oflistBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation.default ListBuildsPublisher
listBuildsPaginator
(Consumer<ListBuildsRequest.Builder> listBuildsRequest) This is a variant oflistBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation.default ListBuildsPublisher
listBuildsPaginator
(ListBuildsRequest listBuildsRequest) This is a variant oflistBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation.default CompletableFuture
<ListComputeResponse> listCompute
(Consumer<ListComputeRequest.Builder> listComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<ListComputeResponse> listCompute
(ListComputeRequest listComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default ListComputePublisher
listComputePaginator
(Consumer<ListComputeRequest.Builder> listComputeRequest) This is a variant oflistCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation.default ListComputePublisher
listComputePaginator
(ListComputeRequest listComputeRequest) This is a variant oflistCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation.listContainerGroupDefinitions
(Consumer<ListContainerGroupDefinitionsRequest.Builder> listContainerGroupDefinitionsRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.listContainerGroupDefinitions
(ListContainerGroupDefinitionsRequest listContainerGroupDefinitionsRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.listContainerGroupDefinitionsPaginator
(Consumer<ListContainerGroupDefinitionsRequest.Builder> listContainerGroupDefinitionsRequest) This is a variant oflistContainerGroupDefinitions(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsRequest)
operation.listContainerGroupDefinitionsPaginator
(ListContainerGroupDefinitionsRequest listContainerGroupDefinitionsRequest) This is a variant oflistContainerGroupDefinitions(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsRequest)
operation.default CompletableFuture
<ListFleetsResponse> This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<ListFleetsResponse> listFleets
(Consumer<ListFleetsRequest.Builder> listFleetsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<ListFleetsResponse> listFleets
(ListFleetsRequest listFleetsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default ListFleetsPublisher
This is a variant oflistFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation.default ListFleetsPublisher
listFleetsPaginator
(Consumer<ListFleetsRequest.Builder> listFleetsRequest) This is a variant oflistFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation.default ListFleetsPublisher
listFleetsPaginator
(ListFleetsRequest listFleetsRequest) This is a variant oflistFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation.listGameServerGroups
(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest) Lists a game server groups.listGameServerGroups
(ListGameServerGroupsRequest listGameServerGroupsRequest) Lists a game server groups.default ListGameServerGroupsPublisher
listGameServerGroupsPaginator
(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest) This is a variant oflistGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation.default ListGameServerGroupsPublisher
listGameServerGroupsPaginator
(ListGameServerGroupsRequest listGameServerGroupsRequest) This is a variant oflistGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation.default CompletableFuture
<ListGameServersResponse> listGameServers
(Consumer<ListGameServersRequest.Builder> listGameServersRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.default CompletableFuture
<ListGameServersResponse> listGameServers
(ListGameServersRequest listGameServersRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.default ListGameServersPublisher
listGameServersPaginator
(Consumer<ListGameServersRequest.Builder> listGameServersRequest) This is a variant oflistGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest)
operation.default ListGameServersPublisher
listGameServersPaginator
(ListGameServersRequest listGameServersRequest) This is a variant oflistGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest)
operation.default CompletableFuture
<ListLocationsResponse> listLocations
(Consumer<ListLocationsRequest.Builder> listLocationsRequest) Lists all custom and Amazon Web Services locations.default CompletableFuture
<ListLocationsResponse> listLocations
(ListLocationsRequest listLocationsRequest) Lists all custom and Amazon Web Services locations.default ListLocationsPublisher
listLocationsPaginator
(Consumer<ListLocationsRequest.Builder> listLocationsRequest) This is a variant oflistLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation.default ListLocationsPublisher
listLocationsPaginator
(ListLocationsRequest listLocationsRequest) This is a variant oflistLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation.default CompletableFuture
<ListScriptsResponse> listScripts
(Consumer<ListScriptsRequest.Builder> listScriptsRequest) Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.default CompletableFuture
<ListScriptsResponse> listScripts
(ListScriptsRequest listScriptsRequest) Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.default ListScriptsPublisher
listScriptsPaginator
(Consumer<ListScriptsRequest.Builder> listScriptsRequest) This is a variant oflistScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation.default ListScriptsPublisher
listScriptsPaginator
(ListScriptsRequest listScriptsRequest) This is a variant oflistScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves all tags assigned to a Amazon GameLift resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves all tags assigned to a Amazon GameLift resource.putScalingPolicy
(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) Creates or updates a scaling policy for a fleet.putScalingPolicy
(PutScalingPolicyRequest putScalingPolicyRequest) Creates or updates a scaling policy for a fleet.default CompletableFuture
<RegisterComputeResponse> registerCompute
(Consumer<RegisterComputeRequest.Builder> registerComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.default CompletableFuture
<RegisterComputeResponse> registerCompute
(RegisterComputeRequest registerComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.registerGameServer
(Consumer<RegisterGameServerRequest.Builder> registerGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.registerGameServer
(RegisterGameServerRequest registerGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.requestUploadCredentials
(Consumer<RequestUploadCredentialsRequest.Builder> requestUploadCredentialsRequest) Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3.requestUploadCredentials
(RequestUploadCredentialsRequest requestUploadCredentialsRequest) Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3.default CompletableFuture
<ResolveAliasResponse> resolveAlias
(Consumer<ResolveAliasRequest.Builder> resolveAliasRequest) Attempts to retrieve a fleet ID that is associated with an alias.default CompletableFuture
<ResolveAliasResponse> resolveAlias
(ResolveAliasRequest resolveAliasRequest) Attempts to retrieve a fleet ID that is associated with an alias.resumeGameServerGroup
(Consumer<ResumeGameServerGroupRequest.Builder> resumeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.resumeGameServerGroup
(ResumeGameServerGroupRequest resumeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.searchGameSessions
(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest) Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.searchGameSessions
(SearchGameSessionsRequest searchGameSessionsRequest) Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.default SearchGameSessionsPublisher
searchGameSessionsPaginator
(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest) This is a variant ofsearchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest)
operation.default SearchGameSessionsPublisher
searchGameSessionsPaginator
(SearchGameSessionsRequest searchGameSessionsRequest) This is a variant ofsearchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartFleetActions
(Consumer<StartFleetActionsRequest.Builder> startFleetActionsRequest) Resumes certain types of activity on fleet instances that were suspended with StopFleetActions.startFleetActions
(StartFleetActionsRequest startFleetActionsRequest) Resumes certain types of activity on fleet instances that were suspended with StopFleetActions.startGameSessionPlacement
(Consumer<StartGameSessionPlacementRequest.Builder> startGameSessionPlacementRequest) Places a request for a new game session in a queue.startGameSessionPlacement
(StartGameSessionPlacementRequest startGameSessionPlacementRequest) Places a request for a new game session in a queue.startMatchBackfill
(Consumer<StartMatchBackfillRequest.Builder> startMatchBackfillRequest) Finds new players to fill open slots in currently running game sessions.startMatchBackfill
(StartMatchBackfillRequest startMatchBackfillRequest) Finds new players to fill open slots in currently running game sessions.startMatchmaking
(Consumer<StartMatchmakingRequest.Builder> startMatchmakingRequest) Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.startMatchmaking
(StartMatchmakingRequest startMatchmakingRequest) Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.stopFleetActions
(Consumer<StopFleetActionsRequest.Builder> stopFleetActionsRequest) Suspends certain types of activity in a fleet location.stopFleetActions
(StopFleetActionsRequest stopFleetActionsRequest) Suspends certain types of activity in a fleet location.stopGameSessionPlacement
(Consumer<StopGameSessionPlacementRequest.Builder> stopGameSessionPlacementRequest) Cancels a game session placement that is inPENDING
status.stopGameSessionPlacement
(StopGameSessionPlacementRequest stopGameSessionPlacementRequest) Cancels a game session placement that is inPENDING
status.default CompletableFuture
<StopMatchmakingResponse> stopMatchmaking
(Consumer<StopMatchmakingRequest.Builder> stopMatchmakingRequest) Cancels a matchmaking ticket or match backfill ticket that is currently being processed.default CompletableFuture
<StopMatchmakingResponse> stopMatchmaking
(StopMatchmakingRequest stopMatchmakingRequest) Cancels a matchmaking ticket or match backfill ticket that is currently being processed.suspendGameServerGroup
(Consumer<SuspendGameServerGroupRequest.Builder> suspendGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.suspendGameServerGroup
(SuspendGameServerGroupRequest suspendGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns a tag to an Amazon GameLift resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Assigns a tag to an Amazon GameLift resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag assigned to a Amazon GameLift resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag assigned to a Amazon GameLift resource.default CompletableFuture
<UpdateAliasResponse> updateAlias
(Consumer<UpdateAliasRequest.Builder> updateAliasRequest) Updates properties for an alias.default CompletableFuture
<UpdateAliasResponse> updateAlias
(UpdateAliasRequest updateAliasRequest) Updates properties for an alias.default CompletableFuture
<UpdateBuildResponse> updateBuild
(Consumer<UpdateBuildRequest.Builder> updateBuildRequest) Updates metadata in a build resource, including the build name and version.default CompletableFuture
<UpdateBuildResponse> updateBuild
(UpdateBuildRequest updateBuildRequest) Updates metadata in a build resource, including the build name and version.updateFleetAttributes
(Consumer<UpdateFleetAttributesRequest.Builder> updateFleetAttributesRequest) Updates a fleet's mutable attributes, such as game session protection and resource creation limits.updateFleetAttributes
(UpdateFleetAttributesRequest updateFleetAttributesRequest) Updates a fleet's mutable attributes, such as game session protection and resource creation limits.updateFleetCapacity
(Consumer<UpdateFleetCapacityRequest.Builder> updateFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.updateFleetCapacity
(UpdateFleetCapacityRequest updateFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.updateFleetPortSettings
(Consumer<UpdateFleetPortSettingsRequest.Builder> updateFleetPortSettingsRequest) Updates permissions that allow inbound traffic to connect to game sessions in the fleet.updateFleetPortSettings
(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest) Updates permissions that allow inbound traffic to connect to game sessions in the fleet.updateGameServer
(Consumer<UpdateGameServerRequest.Builder> updateGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.updateGameServer
(UpdateGameServerRequest updateGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.updateGameServerGroup
(Consumer<UpdateGameServerGroupRequest.Builder> updateGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.updateGameServerGroup
(UpdateGameServerGroupRequest updateGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.updateGameSession
(Consumer<UpdateGameSessionRequest.Builder> updateGameSessionRequest) Updates the mutable properties of a game session.updateGameSession
(UpdateGameSessionRequest updateGameSessionRequest) Updates the mutable properties of a game session.updateGameSessionQueue
(Consumer<UpdateGameSessionQueueRequest.Builder> updateGameSessionQueueRequest) Updates the configuration of a game session queue, which determines how the queue processes new game session requests.updateGameSessionQueue
(UpdateGameSessionQueueRequest updateGameSessionQueueRequest) Updates the configuration of a game session queue, which determines how the queue processes new game session requests.updateMatchmakingConfiguration
(Consumer<UpdateMatchmakingConfigurationRequest.Builder> updateMatchmakingConfigurationRequest) Updates settings for a FlexMatch matchmaking configuration.updateMatchmakingConfiguration
(UpdateMatchmakingConfigurationRequest updateMatchmakingConfigurationRequest) Updates settings for a FlexMatch matchmaking configuration.updateRuntimeConfiguration
(Consumer<UpdateRuntimeConfigurationRequest.Builder> updateRuntimeConfigurationRequest) Updates the runtime configuration for the specified fleet.updateRuntimeConfiguration
(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest) Updates the runtime configuration for the specified fleet.default CompletableFuture
<UpdateScriptResponse> updateScript
(Consumer<UpdateScriptRequest.Builder> updateScriptRequest) Updates Realtime script metadata and content.default CompletableFuture
<UpdateScriptResponse> updateScript
(UpdateScriptRequest updateScriptRequest) Updates Realtime script metadata and content.validateMatchmakingRuleSet
(Consumer<ValidateMatchmakingRuleSetRequest.Builder> validateMatchmakingRuleSetRequest) Validates the syntax of a matchmaking rule or rule set.validateMatchmakingRuleSet
(ValidateMatchmakingRuleSetRequest validateMatchmakingRuleSetRequest) Validates the syntax of a matchmaking rule or rule set.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptMatch
Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status
REQUIRES_ACCEPTANCE
. This is a trigger for your game to get acceptance from all players in each ticket. Calls to this action are only valid for tickets that are in this status; calls for tickets not in this status result in an error.To register acceptance, specify the ticket ID, one or more players, and an acceptance response. When all players have accepted, Amazon GameLift advances the matchmaking tickets to status
PLACING
, and attempts to create a new game session for the match.If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:
-
If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set
CANCELLED
and processing is terminated. -
If all players in the ticket accepted the match, the ticket status is returned to
SEARCHING
to find a new match.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
- Parameters:
acceptMatchRequest
-- Returns:
- A Java Future containing the result of the AcceptMatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
acceptMatch
default CompletableFuture<AcceptMatchResponse> acceptMatch(Consumer<AcceptMatchRequest.Builder> acceptMatchRequest) Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status
REQUIRES_ACCEPTANCE
. This is a trigger for your game to get acceptance from all players in each ticket. Calls to this action are only valid for tickets that are in this status; calls for tickets not in this status result in an error.To register acceptance, specify the ticket ID, one or more players, and an acceptance response. When all players have accepted, Amazon GameLift advances the matchmaking tickets to status
PLACING
, and attempts to create a new game session for the match.If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:
-
If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set
CANCELLED
and processing is terminated. -
If all players in the ticket accepted the match, the ticket status is returned to
SEARCHING
to find a new match.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
This is a convenience which creates an instance of the
AcceptMatchRequest.Builder
avoiding the need to create one manually viaAcceptMatchRequest.builder()
- Parameters:
acceptMatchRequest
- AConsumer
that will call methods onAcceptMatchRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AcceptMatch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
claimGameServer
default CompletableFuture<ClaimGameServerResponse> claimGameServer(ClaimGameServerRequest claimGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in
CLAIMED
status for 60 seconds, and returns connection information that players can use to connect to the game server.To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on
ACTIVE
instances to be claimed.When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains
AVAILABLE
while the claim status is set toCLAIMED
for up to 60 seconds. This time period gives the game server time to update its status toUTILIZED
after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.If you try to claim a specific game server, this request will fail in the following cases:
-
If the game server utilization status is
UTILIZED
. -
If the game server claim status is
CLAIMED
. -
If the game server is running on an instance in
DRAINING
status and the provided filter option does not allow placing onDRAINING
instances.
Learn more
- Parameters:
claimGameServerRequest
-- Returns:
- A Java Future containing the result of the ClaimGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- OutOfCapacityException The specified game server group has no available game servers to fulfill a
ClaimGameServer
request. Clients can retry such requests immediately or after a waiting period. - UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
claimGameServer
default CompletableFuture<ClaimGameServerResponse> claimGameServer(Consumer<ClaimGameServerRequest.Builder> claimGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, Amazon GameLift FleetIQ locates an available game server, places it in
CLAIMED
status for 60 seconds, and returns connection information that players can use to connect to the game server.To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses Amazon GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information. Add filter options to further restrict how a game server is chosen, such as only allowing game servers on
ACTIVE
instances to be claimed.When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains
AVAILABLE
while the claim status is set toCLAIMED
for up to 60 seconds. This time period gives the game server time to update its status toUTILIZED
after players join. If the game server's status is not updated within 60 seconds, the game server reverts to unclaimed status and is available to be claimed by another request. The claim time period is a fixed value and is not configurable.If you try to claim a specific game server, this request will fail in the following cases:
-
If the game server utilization status is
UTILIZED
. -
If the game server claim status is
CLAIMED
. -
If the game server is running on an instance in
DRAINING
status and the provided filter option does not allow placing onDRAINING
instances.
Learn more
This is a convenience which creates an instance of the
ClaimGameServerRequest.Builder
avoiding the need to create one manually viaClaimGameServerRequest.builder()
- Parameters:
claimGameServerRequest
- AConsumer
that will call methods onClaimGameServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ClaimGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- OutOfCapacityException The specified game server group has no available game servers to fulfill a
ClaimGameServer
request. Clients can retry such requests immediately or after a waiting period. - UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createAlias
Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.
Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.
To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling
UpdateAlias
.Related actions
- Parameters:
createAliasRequest
-- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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 immediately or after a waiting period.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlias
default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.
Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.
To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling
UpdateAlias
.Related actions
This is a convenience which creates an instance of the
CreateAliasRequest.Builder
avoiding the need to create one manually viaCreateAliasRequest.builder()
- Parameters:
createAliasRequest
- AConsumer
that will call methods onCreateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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 immediately or after a waiting period.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBuild
Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.
When setting up a new game build for Amazon GameLift, we recommend using the CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource.
You can use the
CreateBuild
operation in the following scenarios:-
Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.
-
Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them.
If successful, this operation creates a new build resource with a unique build ID and places it in
INITIALIZED
status. A build must be inREADY
status before you can create fleets with it.Learn more
- Parameters:
createBuildRequest
-- Returns:
- A Java Future containing the result of the CreateBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createBuild
default CompletableFuture<CreateBuildResponse> createBuild(Consumer<CreateBuildRequest.Builder> createBuildRequest) Creates a new Amazon GameLift build resource for your game server binary files. Combine game server binaries into a zip file for use with Amazon GameLift.
When setting up a new game build for Amazon GameLift, we recommend using the CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to an Amazon GameLift Amazon S3 location, and (2) it creates a new build resource.
You can use the
CreateBuild
operation in the following scenarios:-
Create a new game build with build files that are in an Amazon S3 location under an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, specify a build name, operating system, and the Amazon S3 storage location of your game build.
-
Upload your build files to a Amazon GameLift Amazon S3 location. To use this option, specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. After you upload build files to the Amazon GameLift Amazon S3 location, you can't update them.
If successful, this operation creates a new build resource with a unique build ID and places it in
INITIALIZED
status. A build must be inREADY
status before you can create fleets with it.Learn more
Create a Build with Files in Amazon S3
This is a convenience which creates an instance of the
CreateBuildRequest.Builder
avoiding the need to create one manually viaCreateBuildRequest.builder()
- Parameters:
createBuildRequest
- AConsumer
that will call methods onCreateBuildRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createContainerGroupDefinition
default CompletableFuture<CreateContainerGroupDefinitionResponse> createContainerGroupDefinition(CreateContainerGroupDefinitionRequest createContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Creates a
ContainerGroupDefinition
resource that describes a set of containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container group is similar to a container "task" and "pod". Each container group can have one or more containers.Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet.
You can create two types of container groups, based on scheduling strategy:
-
A replica container group manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources.
-
A daemon container group manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group.
To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file.
This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift for help setting the appropriate permissions.
If successful, this operation creates a new
ContainerGroupDefinition
resource with an ARN value assigned. You can't change the properties of a container group definition. Instead, create a new one.Learn more
- Parameters:
createContainerGroupDefinitionRequest
-- Returns:
- A Java Future containing the result of the CreateContainerGroupDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createContainerGroupDefinition
default CompletableFuture<CreateContainerGroupDefinitionResponse> createContainerGroupDefinition(Consumer<CreateContainerGroupDefinitionRequest.Builder> createContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Creates a
ContainerGroupDefinition
resource that describes a set of containers for hosting your game server with Amazon GameLift managed EC2 hosting. An Amazon GameLift container group is similar to a container "task" and "pod". Each container group can have one or more containers.Use container group definitions when you create a container fleet. Container group definitions determine how Amazon GameLift deploys your containers to each instance in a container fleet.
You can create two types of container groups, based on scheduling strategy:
-
A replica container group manages the containers that run your game server application and supporting software. Replica container groups might be replicated multiple times on each fleet instance, depending on instance resources.
-
A daemon container group manages containers that run other software, such as background services, logging, or test processes. You might use a daemon container group for processes that need to run only once per fleet instance, or processes that need to persist independently of the replica container group.
To create a container group definition, specify a group name, a list of container definitions, and maximum total CPU and memory requirements for the container group. Specify an operating system and scheduling strategy or use the default values. When using the Amazon Web Services CLI tool, you can pass in your container definitions as a JSON file.
This operation requires Identity and Access Management (IAM) permissions to access container images in Amazon ECR repositories. See IAM permissions for Amazon GameLift for help setting the appropriate permissions.
If successful, this operation creates a new
ContainerGroupDefinition
resource with an ARN value assigned. You can't change the properties of a container group definition. Instead, create a new one.Learn more
This is a convenience which creates an instance of the
CreateContainerGroupDefinitionRequest.Builder
avoiding the need to create one manually viaCreateContainerGroupDefinitionRequest.builder()
- Parameters:
createContainerGroupDefinitionRequest
- AConsumer
that will call methods onCreateContainerGroupDefinitionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateContainerGroupDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createFleet
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:
Managed EC2 fleet
An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a
Compute
.To create an EC2 fleet, provide these required parameters:
-
Either
BuildId
orScriptId
-
ComputeType
set toEC2
(the default value) -
EC2InboundPermissions
-
EC2InstanceType
-
FleetType
-
Name
-
RuntimeConfiguration
with at least oneServerProcesses
configuration
If successful, this operation creates a new fleet resource and places it in
NEW
status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.
Managed container fleet
A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a
Compute
.To create a container fleet, provide these required parameters:
-
ComputeType
set toCONTAINER
-
ContainerGroupsConfiguration
-
EC2InboundPermissions
-
EC2InstanceType
-
FleetType
set toON_DEMAND
-
Name
-
RuntimeConfiguration
with at least oneServerProcesses
configuration
If successful, this operation creates a new fleet resource and places it in
NEW
status while Amazon GameLift initiates the fleet creation workflow.When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.
Anywhere fleet
An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.
To create an Anywhere fleet, provide these required parameters:
-
ComputeType
set toANYWHERE
-
Locations
specifying a custom location -
Name
If successful, this operation creates a new fleet resource and places it in
ACTIVE
status. You can register computes with a fleet inACTIVE
status.Learn more
- Parameters:
createFleetRequest
-- Returns:
- A Java Future containing the result of the CreateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.
- 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createFleet
default CompletableFuture<CreateFleetResponse> createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:
Managed EC2 fleet
An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your game server build is deployed to each fleet instance. Amazon GameLift manages the fleet's instances and controls the lifecycle of game server processes, which host game sessions for players. EC2 fleets can have instances in multiple locations. Each instance in the fleet is designated a
Compute
.To create an EC2 fleet, provide these required parameters:
-
Either
BuildId
orScriptId
-
ComputeType
set toEC2
(the default value) -
EC2InboundPermissions
-
EC2InstanceType
-
FleetType
-
Name
-
RuntimeConfiguration
with at least oneServerProcesses
configuration
If successful, this operation creates a new fleet resource and places it in
NEW
status while Amazon GameLift initiates the fleet creation workflow. To debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create a development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished.When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.
Managed container fleet
A container fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances. Your container architecture is deployed to each fleet instance based on the fleet configuration. Amazon GameLift manages the containers on each fleet instance and controls the lifecycle of game server processes, which host game sessions for players. Container fleets can have instances in multiple locations. Each container on an instance that runs game server processes is registered as a
Compute
.To create a container fleet, provide these required parameters:
-
ComputeType
set toCONTAINER
-
ContainerGroupsConfiguration
-
EC2InboundPermissions
-
EC2InstanceType
-
FleetType
set toON_DEMAND
-
Name
-
RuntimeConfiguration
with at least oneServerProcesses
configuration
If successful, this operation creates a new fleet resource and places it in
NEW
status while Amazon GameLift initiates the fleet creation workflow.When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.
Anywhere fleet
An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.
To create an Anywhere fleet, provide these required parameters:
-
ComputeType
set toANYWHERE
-
Locations
specifying a custom location -
Name
If successful, this operation creates a new fleet resource and places it in
ACTIVE
status. You can register computes with a fleet inACTIVE
status.Learn more
This is a convenience which creates an instance of the
CreateFleetRequest.Builder
avoiding the need to create one manually viaCreateFleetRequest.builder()
- Parameters:
createFleetRequest
- AConsumer
that will call methods onCreateFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.
- 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createFleetLocations
default CompletableFuture<CreateFleetLocationsResponse> createFleetLocations(CreateFleetLocationsRequest createFleetLocationsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with their status set to
NEW
. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.Learn more
- Parameters:
createFleetLocationsRequest
-- Returns:
- A Java Future containing the result of the CreateFleetLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.
- 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.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createFleetLocations
default CompletableFuture<CreateFleetLocationsResponse> createFleetLocations(Consumer<CreateFleetLocationsRequest.Builder> createFleetLocationsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Adds remote locations to an EC2 or container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
You can't add remote locations to a fleet that resides in an Amazon Web Services Region that doesn't support multiple locations. Fleets created prior to March 2021 can't support multiple locations.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with their status set to
NEW
. Amazon GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents.Learn more
This is a convenience which creates an instance of the
CreateFleetLocationsRequest.Builder
avoiding the need to create one manually viaCreateFleetLocationsRequest.builder()
- Parameters:
createFleetLocationsRequest
- AConsumer
that will call methods onCreateFleetLocationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateFleetLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.
- 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.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGameServerGroup
default CompletableFuture<CreateGameServerGroupResponse> createGameServerGroup(CreateGameServerGroupRequest createGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
-
An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.
-
An IAM role that extends limited access to your Amazon Web Services account to allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the Amazon GameLift FleetIQ Developer Guide.
To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
- Parameters:
createGameServerGroupRequest
-- Returns:
- A Java Future containing the result of the CreateGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGameServerGroup
default CompletableFuture<CreateGameServerGroupResponse> createGameServerGroup(Consumer<CreateGameServerGroupRequest.Builder> createGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
-
An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.
-
An IAM role that extends limited access to your Amazon Web Services account to allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the Amazon GameLift FleetIQ Developer Guide.
To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
This is a convenience which creates an instance of the
CreateGameServerGroupRequest.Builder
avoiding the need to create one manually viaCreateGameServerGroupRequest.builder()
- Parameters:
createGameServerGroupRequest
- AConsumer
that will call methods onCreateGameServerGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGameSession
default CompletableFuture<CreateGameSessionResponse> createGameSession(CreateGameSessionRequest createGameSessionRequest) Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement , which uses the FleetIQ algorithm and queues to optimize the placement process.
When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The target fleet must be in
ACTIVE
status.You can use this operation in the following ways:
-
To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.
-
To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.
-
To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.
If successful, Amazon GameLift initiates a workflow to start a new game session and returns a
GameSession
object containing the game session configuration and status. When the game session status isACTIVE
, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.Amazon GameLift retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
Learn more
- Parameters:
createGameSessionRequest
-- Returns:
- A Java Future containing the result of the CreateGameSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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.
- 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 parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- FleetCapacityExceededException The specified fleet has no available instances to fulfill a
CreateGameSession
request. Clients can retry such requests immediately or after a waiting period. - LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- IdempotentParameterMismatchException A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGameSession
default CompletableFuture<CreateGameSessionResponse> createGameSession(Consumer<CreateGameSessionRequest.Builder> createGameSessionRequest) Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement , which uses the FleetIQ algorithm and queues to optimize the placement process.
When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The target fleet must be in
ACTIVE
status.You can use this operation in the following ways:
-
To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.
-
To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.
-
To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.
If successful, Amazon GameLift initiates a workflow to start a new game session and returns a
GameSession
object containing the game session configuration and status. When the game session status isACTIVE
, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.Amazon GameLift retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
Learn more
This is a convenience which creates an instance of the
CreateGameSessionRequest.Builder
avoiding the need to create one manually viaCreateGameSessionRequest.builder()
- Parameters:
createGameSessionRequest
- AConsumer
that will call methods onCreateGameSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGameSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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.
- 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 parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- FleetCapacityExceededException The specified fleet has no available instances to fulfill a
CreateGameSession
request. Clients can retry such requests immediately or after a waiting period. - LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- IdempotentParameterMismatchException A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createGameSessionQueue
default CompletableFuture<CreateGameSessionQueueResponse> createGameSessionQueue(CreateGameSessionQueueRequest createGameSessionQueueRequest) Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.
A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.
The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.
To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.
If successful, a new
GameSessionQueue
object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
- Parameters:
createGameSessionQueueRequest
-- Returns:
- A Java Future containing the result of the CreateGameSessionQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGameSessionQueue
default CompletableFuture<CreateGameSessionQueueResponse> createGameSessionQueue(Consumer<CreateGameSessionQueueRequest.Builder> createGameSessionQueueRequest) Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.
A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.
The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.
To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.
If successful, a new
GameSessionQueue
object is returned with an assigned queue ARN. New game session requests, which are submitted to queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
This is a convenience which creates an instance of the
CreateGameSessionQueueRequest.Builder
avoiding the need to create one manually viaCreateGameSessionQueueRequest.builder()
- Parameters:
createGameSessionQueueRequest
- AConsumer
that will call methods onCreateGameSessionQueueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGameSessionQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLocation
default CompletableFuture<CreateLocationResponse> createLocation(CreateLocationRequest createLocationRequest) Creates a custom location for use in an Anywhere fleet.
- Parameters:
createLocationRequest
-- Returns:
- A Java Future containing the result of the CreateLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue 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.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createLocation
default CompletableFuture<CreateLocationResponse> createLocation(Consumer<CreateLocationRequest.Builder> createLocationRequest) Creates a custom location for use in an Anywhere fleet.
This is a convenience which creates an instance of the
CreateLocationRequest.Builder
avoiding the need to create one manually viaCreateLocationRequest.builder()
- Parameters:
createLocationRequest
- AConsumer
that will call methods onCreateLocationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue 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.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMatchmakingConfiguration
default CompletableFuture<CreateMatchmakingConfigurationResponse> createMatchmakingConfiguration(CreateMatchmakingConfigurationRequest createMatchmakingConfigurationRequest) Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.
To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.
In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.
Learn more
- Parameters:
createMatchmakingConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateMatchmakingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMatchmakingConfiguration
default CompletableFuture<CreateMatchmakingConfigurationResponse> createMatchmakingConfiguration(Consumer<CreateMatchmakingConfigurationRequest.Builder> createMatchmakingConfigurationRequest) Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.
To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.
In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.
Learn more
Set up FlexMatch event notification
This is a convenience which creates an instance of the
CreateMatchmakingConfigurationRequest.Builder
avoiding the need to create one manually viaCreateMatchmakingConfigurationRequest.builder()
- Parameters:
createMatchmakingConfigurationRequest
- AConsumer
that will call methods onCreateMatchmakingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMatchmakingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMatchmakingRuleSet
default CompletableFuture<CreateMatchmakingRuleSetResponse> createMatchmakingRuleSet(CreateMatchmakingRuleSetRequest createMatchmakingRuleSetRequest) Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.
Learn more
- Parameters:
createMatchmakingRuleSetRequest
-- Returns:
- A Java Future containing the result of the CreateMatchmakingRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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 immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMatchmakingRuleSet
default CompletableFuture<CreateMatchmakingRuleSetResponse> createMatchmakingRuleSet(Consumer<CreateMatchmakingRuleSetRequest.Builder> createMatchmakingRuleSetRequest) Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.
Learn more
This is a convenience which creates an instance of the
CreateMatchmakingRuleSetRequest.Builder
avoiding the need to create one manually viaCreateMatchmakingRuleSetRequest.builder()
- Parameters:
createMatchmakingRuleSetRequest
- AConsumer
that will call methods onCreateMatchmakingRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMatchmakingRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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 immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlayerSession
default CompletableFuture<CreatePlayerSessionResponse> createPlayerSession(CreatePlayerSessionRequest createPlayerSessionRequest) Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in
ACTIVE
status and has a player creation policy ofACCEPT_ALL
. You can add a group of players to a game session with CreatePlayerSessions .To create a player session, specify a game session ID, player ID, and optionally a set of player data.
If successful, a slot is reserved in the game session for the player and a new
PlayerSessions
object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.The maximum number of players per game session is 200. It is not adjustable.
Related actions
- Parameters:
createPlayerSessionRequest
-- Returns:
- A Java Future containing the result of the CreatePlayerSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
- GameSessionFullException The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.
- 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 parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlayerSession
default CompletableFuture<CreatePlayerSessionResponse> createPlayerSession(Consumer<CreatePlayerSessionRequest.Builder> createPlayerSessionRequest) Reserves an open player slot in a game session for a player. New player sessions can be created in any game session with an open slot that is in
ACTIVE
status and has a player creation policy ofACCEPT_ALL
. You can add a group of players to a game session with CreatePlayerSessions .To create a player session, specify a game session ID, player ID, and optionally a set of player data.
If successful, a slot is reserved in the game session for the player and a new
PlayerSessions
object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.The maximum number of players per game session is 200. It is not adjustable.
Related actions
This is a convenience which creates an instance of the
CreatePlayerSessionRequest.Builder
avoiding the need to create one manually viaCreatePlayerSessionRequest.builder()
- Parameters:
createPlayerSessionRequest
- AConsumer
that will call methods onCreatePlayerSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePlayerSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
- GameSessionFullException The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.
- 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 parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlayerSessions
default CompletableFuture<CreatePlayerSessionsResponse> createPlayerSessions(CreatePlayerSessionsRequest createPlayerSessionsRequest) Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in
ACTIVE
status and has a player creation policy ofACCEPT_ALL
. To add a single player to a game session, use CreatePlayerSessionTo create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.
If successful, a slot is reserved in the game session for each player, and new
PlayerSession
objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.The maximum number of players per game session is 200. It is not adjustable.
Related actions
- Parameters:
createPlayerSessionsRequest
-- Returns:
- A Java Future containing the result of the CreatePlayerSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
- GameSessionFullException The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.
- 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 parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPlayerSessions
default CompletableFuture<CreatePlayerSessionsResponse> createPlayerSessions(Consumer<CreatePlayerSessionsRequest.Builder> createPlayerSessionsRequest) Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in
ACTIVE
status and has a player creation policy ofACCEPT_ALL
. To add a single player to a game session, use CreatePlayerSessionTo create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.
If successful, a slot is reserved in the game session for each player, and new
PlayerSession
objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the Amazon GameLift service. Player sessions cannot be updated.The maximum number of players per game session is 200. It is not adjustable.
Related actions
This is a convenience which creates an instance of the
CreatePlayerSessionsRequest.Builder
avoiding the need to create one manually viaCreatePlayerSessionsRequest.builder()
- Parameters:
createPlayerSessionsRequest
- AConsumer
that will call methods onCreatePlayerSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePlayerSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
- GameSessionFullException The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.
- 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 parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createScript
default CompletableFuture<CreateScriptResponse> createScript(CreateScriptRequest createScriptRequest) Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:
-
A locally available directory. Use the ZipFile parameter for this option.
-
An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.
If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
- Parameters:
createScriptRequest
-- Returns:
- A Java Future containing the result of the CreateScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createScript
default CompletableFuture<CreateScriptResponse> createScript(Consumer<CreateScriptRequest.Builder> createScriptRequest) Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.
To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:
-
A locally available directory. Use the ZipFile parameter for this option.
-
An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.
If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
This is a convenience which creates an instance of the
CreateScriptRequest.Builder
avoiding the need to create one manually viaCreateScriptRequest.builder()
- Parameters:
createScriptRequest
- AConsumer
that will call methods onCreateScriptRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createVpcPeeringAuthorization
default CompletableFuture<CreateVpcPeeringAuthorizationResponse> createVpcPeeringAuthorization(CreateVpcPeeringAuthorizationRequest createVpcPeeringAuthorizationRequest) Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.
You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.
To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.
To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.
The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.
Related actions
- Parameters:
createVpcPeeringAuthorizationRequest
-- Returns:
- A Java Future containing the result of the CreateVpcPeeringAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcPeeringAuthorization
default CompletableFuture<CreateVpcPeeringAuthorizationResponse> createVpcPeeringAuthorization(Consumer<CreateVpcPeeringAuthorizationRequest.Builder> createVpcPeeringAuthorizationRequest) Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. After you've received authorization, use CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.
You can peer with VPCs that are owned by any Amazon Web Services account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions.
To request authorization to create a connection, call this operation from the Amazon Web Services account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.
To request authorization to delete a connection, call this operation from the Amazon Web Services account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the Amazon Web Services account that you use to manage Amazon GameLift.
The authorization remains valid for 24 hours unless it is canceled. You must create or delete the peering connection while the authorization is valid.
Related actions
This is a convenience which creates an instance of the
CreateVpcPeeringAuthorizationRequest.Builder
avoiding the need to create one manually viaCreateVpcPeeringAuthorizationRequest.builder()
- Parameters:
createVpcPeeringAuthorizationRequest
- AConsumer
that will call methods onCreateVpcPeeringAuthorizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVpcPeeringAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcPeeringConnection
default CompletableFuture<CreateVpcPeeringConnectionResponse> createVpcPeeringConnection(CreateVpcPeeringConnectionRequest createVpcPeeringConnectionRequest) Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.
Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.
To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .
Related actions
- Parameters:
createVpcPeeringConnectionRequest
-- Returns:
- A Java Future containing the result of the CreateVpcPeeringConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVpcPeeringConnection
default CompletableFuture<CreateVpcPeeringConnectionResponse> createVpcPeeringConnection(Consumer<CreateVpcPeeringConnectionRequest.Builder> createVpcPeeringConnectionRequest) Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different Regions. For more information, see VPC Peering with Amazon GameLift Fleets.
Before calling this operation to establish the peering connection, you first need to use CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.
To establish the connection, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a connection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections , or by monitoring fleet events for success or failure using DescribeFleetEvents .
Related actions
This is a convenience which creates an instance of the
CreateVpcPeeringConnectionRequest.Builder
avoiding the need to create one manually viaCreateVpcPeeringConnectionRequest.builder()
- Parameters:
createVpcPeeringConnectionRequest
- AConsumer
that will call methods onCreateVpcPeeringConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVpcPeeringConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlias
Deletes an alias. This operation 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.
Related actions
- Parameters:
deleteAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlias
default CompletableFuture<DeleteAliasResponse> deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) Deletes an alias. This operation 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.
Related actions
This is a convenience which creates an instance of the
DeleteAliasRequest.Builder
avoiding the need to create one manually viaDeleteAliasRequest.builder()
- Parameters:
deleteAliasRequest
- AConsumer
that will call methods onDeleteAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBuild
Deletes a build. This operation permanently deletes the build resource and any uploaded build files. 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.
To delete a build, specify the build ID.
Learn more
- Parameters:
deleteBuildRequest
-- Returns:
- A Java Future containing the result of the DeleteBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBuild
default CompletableFuture<DeleteBuildResponse> deleteBuild(Consumer<DeleteBuildRequest.Builder> deleteBuildRequest) Deletes a build. This operation permanently deletes the build resource and any uploaded build files. 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.
To delete a build, specify the build ID.
Learn more
This is a convenience which creates an instance of the
DeleteBuildRequest.Builder
avoiding the need to create one manually viaDeleteBuildRequest.builder()
- Parameters:
deleteBuildRequest
- AConsumer
that will call methods onDeleteBuildRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteContainerGroupDefinition
default CompletableFuture<DeleteContainerGroupDefinitionResponse> deleteContainerGroupDefinition(DeleteContainerGroupDefinitionRequest deleteContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Deletes a container group definition resource. You can delete a container group definition if there are no fleets using the definition.
To delete a container group definition, identify the resource to delete.
Learn more
- Parameters:
deleteContainerGroupDefinitionRequest
-- Returns:
- A Java Future containing the result of the DeleteContainerGroupDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteContainerGroupDefinition
default CompletableFuture<DeleteContainerGroupDefinitionResponse> deleteContainerGroupDefinition(Consumer<DeleteContainerGroupDefinitionRequest.Builder> deleteContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Deletes a container group definition resource. You can delete a container group definition if there are no fleets using the definition.
To delete a container group definition, identify the resource to delete.
Learn more
This is a convenience which creates an instance of the
DeleteContainerGroupDefinitionRequest.Builder
avoiding the need to create one manually viaDeleteContainerGroupDefinitionRequest.builder()
- Parameters:
deleteContainerGroupDefinitionRequest
- AConsumer
that will call methods onDeleteContainerGroupDefinitionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteContainerGroupDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFleet
Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.
If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the VPC peering connection.
To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to
DELETING
. When completed, the status switches toTERMINATED
and the fleet eventFLEET_DELETED
is emitted.Learn more
- Parameters:
deleteFleetRequest
-- Returns:
- A Java Future containing the result of the DeleteFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting 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 requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFleet
default CompletableFuture<DeleteFleetResponse> deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest) Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.
If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You don't need to explicitly delete the VPC peering connection.
To delete a fleet, specify the fleet ID to be terminated. During the deletion process, the fleet status is changed to
DELETING
. When completed, the status switches toTERMINATED
and the fleet eventFLEET_DELETED
is emitted.Learn more
Setting up Amazon GameLift Fleets
This is a convenience which creates an instance of the
DeleteFleetRequest.Builder
avoiding the need to create one manually viaDeleteFleetRequest.builder()
- Parameters:
deleteFleetRequest
- AConsumer
that will call methods onDeleteFleetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteFleet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting 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 requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFleetLocations
default CompletableFuture<DeleteFleetLocationsResponse> deleteFleetLocations(DeleteFleetLocationsRequest deleteFleetLocationsRequest) Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.
To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.
If successful, GameLift sets the location status to
DELETING
, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes toTERMINATED
.Learn more
- Parameters:
deleteFleetLocationsRequest
-- Returns:
- A Java Future containing the result of the DeleteFleetLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteFleetLocations
default CompletableFuture<DeleteFleetLocationsResponse> deleteFleetLocations(Consumer<DeleteFleetLocationsRequest.Builder> deleteFleetLocationsRequest) Removes locations from a multi-location fleet. When deleting a location, all game server process and all instances that are still active in the location are shut down.
To delete fleet locations, identify the fleet ID and provide a list of the locations to be deleted.
If successful, GameLift sets the location status to
DELETING
, and begins to shut down existing server processes and terminate instances in each location being deleted. When completed, the location status changes toTERMINATED
.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DeleteFleetLocationsRequest.Builder
avoiding the need to create one manually viaDeleteFleetLocationsRequest.builder()
- Parameters:
deleteFleetLocationsRequest
- AConsumer
that will call methods onDeleteFleetLocationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteFleetLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGameServerGroup
default CompletableFuture<DeleteGameServerGroupResponse> deleteGameServerGroup(DeleteGameServerGroupRequest deleteGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
-
The game server group
-
The corresponding Auto Scaling group
-
All game servers that are currently running in the group
To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in
ACTIVE
orERROR
status.If the delete request is successful, a series of operations are kicked off. The game server group status is changed to
DELETE_SCHEDULED
, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed inERROR
status.Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
- Parameters:
deleteGameServerGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteGameServerGroup
default CompletableFuture<DeleteGameServerGroupResponse> deleteGameServerGroup(Consumer<DeleteGameServerGroupRequest.Builder> deleteGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
-
The game server group
-
The corresponding Auto Scaling group
-
All game servers that are currently running in the group
To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in
ACTIVE
orERROR
status.If the delete request is successful, a series of operations are kicked off. The game server group status is changed to
DELETE_SCHEDULED
, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, Amazon GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed inERROR
status.Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
This is a convenience which creates an instance of the
DeleteGameServerGroupRequest.Builder
avoiding the need to create one manually viaDeleteGameServerGroupRequest.builder()
- Parameters:
deleteGameServerGroupRequest
- AConsumer
that will call methods onDeleteGameServerGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteGameSessionQueue
default CompletableFuture<DeleteGameSessionQueueResponse> deleteGameSessionQueue(DeleteGameSessionQueueRequest deleteGameSessionQueueRequest) Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.
- Parameters:
deleteGameSessionQueueRequest
-- Returns:
- A Java Future containing the result of the DeleteGameSessionQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGameSessionQueue
default CompletableFuture<DeleteGameSessionQueueResponse> deleteGameSessionQueue(Consumer<DeleteGameSessionQueueRequest.Builder> deleteGameSessionQueueRequest) Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.
This is a convenience which creates an instance of the
DeleteGameSessionQueueRequest.Builder
avoiding the need to create one manually viaDeleteGameSessionQueueRequest.builder()
- Parameters:
deleteGameSessionQueueRequest
- AConsumer
that will call methods onDeleteGameSessionQueueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGameSessionQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLocation
default CompletableFuture<DeleteLocationResponse> deleteLocation(DeleteLocationRequest deleteLocationRequest) Deletes a custom location.
Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see DeregisterCompute.
- Parameters:
deleteLocationRequest
-- Returns:
- A Java Future containing the result of the DeleteLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteLocation
default CompletableFuture<DeleteLocationResponse> deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest) Deletes a custom location.
Before deleting a custom location, review any fleets currently using the custom location and deregister the location if it is in use. For more information, see DeregisterCompute.
This is a convenience which creates an instance of the
DeleteLocationRequest.Builder
avoiding the need to create one manually viaDeleteLocationRequest.builder()
- Parameters:
deleteLocationRequest
- AConsumer
that will call methods onDeleteLocationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMatchmakingConfiguration
default CompletableFuture<DeleteMatchmakingConfigurationResponse> deleteMatchmakingConfiguration(DeleteMatchmakingConfigurationRequest deleteMatchmakingConfigurationRequest) Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.
- Parameters:
deleteMatchmakingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteMatchmakingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMatchmakingConfiguration
default CompletableFuture<DeleteMatchmakingConfigurationResponse> deleteMatchmakingConfiguration(Consumer<DeleteMatchmakingConfigurationRequest.Builder> deleteMatchmakingConfigurationRequest) Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.
This is a convenience which creates an instance of the
DeleteMatchmakingConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteMatchmakingConfigurationRequest.builder()
- Parameters:
deleteMatchmakingConfigurationRequest
- AConsumer
that will call methods onDeleteMatchmakingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMatchmakingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMatchmakingRuleSet
default CompletableFuture<DeleteMatchmakingRuleSetResponse> deleteMatchmakingRuleSet(DeleteMatchmakingRuleSetRequest deleteMatchmakingRuleSetRequest) Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.
Learn more
- Parameters:
deleteMatchmakingRuleSetRequest
-- Returns:
- A Java Future containing the result of the DeleteMatchmakingRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMatchmakingRuleSet
default CompletableFuture<DeleteMatchmakingRuleSetResponse> deleteMatchmakingRuleSet(Consumer<DeleteMatchmakingRuleSetRequest.Builder> deleteMatchmakingRuleSetRequest) Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.
Learn more
This is a convenience which creates an instance of the
DeleteMatchmakingRuleSetRequest.Builder
avoiding the need to create one manually viaDeleteMatchmakingRuleSetRequest.builder()
- Parameters:
deleteMatchmakingRuleSetRequest
- AConsumer
that will call methods onDeleteMatchmakingRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMatchmakingRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScalingPolicy
default CompletableFuture<DeleteScalingPolicyResponse> deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest) Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.
- Parameters:
deleteScalingPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteScalingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScalingPolicy
default CompletableFuture<DeleteScalingPolicyResponse> deleteScalingPolicy(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest) Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.
This is a convenience which creates an instance of the
DeleteScalingPolicyRequest.Builder
avoiding the need to create one manually viaDeleteScalingPolicyRequest.builder()
- Parameters:
deleteScalingPolicyRequest
- AConsumer
that will call methods onDeleteScalingPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteScalingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScript
default CompletableFuture<DeleteScriptResponse> deleteScript(DeleteScriptRequest deleteScriptRequest) Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).
To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
- Parameters:
deleteScriptRequest
-- Returns:
- A Java Future containing the result of the DeleteScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteScript
default CompletableFuture<DeleteScriptResponse> deleteScript(Consumer<DeleteScriptRequest.Builder> deleteScriptRequest) Deletes a Realtime script. This operation permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).
To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
This is a convenience which creates an instance of the
DeleteScriptRequest.Builder
avoiding the need to create one manually viaDeleteScriptRequest.builder()
- Parameters:
deleteScriptRequest
- AConsumer
that will call methods onDeleteScriptRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcPeeringAuthorization
default CompletableFuture<DeleteVpcPeeringAuthorizationResponse> deleteVpcPeeringAuthorization(DeleteVpcPeeringAuthorizationRequest deleteVpcPeeringAuthorizationRequest) Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.
Related actions
- Parameters:
deleteVpcPeeringAuthorizationRequest
-- Returns:
- A Java Future containing the result of the DeleteVpcPeeringAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcPeeringAuthorization
default CompletableFuture<DeleteVpcPeeringAuthorizationResponse> deleteVpcPeeringAuthorization(Consumer<DeleteVpcPeeringAuthorizationRequest.Builder> deleteVpcPeeringAuthorizationRequest) Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.
Related actions
This is a convenience which creates an instance of the
DeleteVpcPeeringAuthorizationRequest.Builder
avoiding the need to create one manually viaDeleteVpcPeeringAuthorizationRequest.builder()
- Parameters:
deleteVpcPeeringAuthorizationRequest
- AConsumer
that will call methods onDeleteVpcPeeringAuthorizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVpcPeeringAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcPeeringConnection
default CompletableFuture<DeleteVpcPeeringConnectionResponse> deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest) Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..
Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.
Related actions
- Parameters:
deleteVpcPeeringConnectionRequest
-- Returns:
- A Java Future containing the result of the DeleteVpcPeeringConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVpcPeeringConnection
default CompletableFuture<DeleteVpcPeeringConnectionResponse> deleteVpcPeeringConnection(Consumer<DeleteVpcPeeringConnectionRequest.Builder> deleteVpcPeeringConnectionRequest) Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete..
Once a valid authorization exists, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.
Related actions
This is a convenience which creates an instance of the
DeleteVpcPeeringConnectionRequest.Builder
avoiding the need to create one manually viaDeleteVpcPeeringConnectionRequest.builder()
- Parameters:
deleteVpcPeeringConnectionRequest
- AConsumer
that will call methods onDeleteVpcPeeringConnectionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVpcPeeringConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterCompute
default CompletableFuture<DeregisterComputeResponse> deregisterCompute(DeregisterComputeRequest deregisterComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions through Amazon GameLift.
For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes.
To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID.
- Parameters:
deregisterComputeRequest
-- Returns:
- A Java Future containing the result of the DeregisterCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterCompute
default CompletableFuture<DeregisterComputeResponse> deregisterCompute(Consumer<DeregisterComputeRequest.Builder> deregisterComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet. Deregistered computes can no longer host game sessions through Amazon GameLift.
For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes.
To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID.
This is a convenience which creates an instance of the
DeregisterComputeRequest.Builder
avoiding the need to create one manually viaDeregisterComputeRequest.builder()
- Parameters:
deregisterComputeRequest
- AConsumer
that will call methods onDeregisterComputeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterGameServer
default CompletableFuture<DeregisterGameServerResponse> deregisterGameServer(DeregisterGameServerRequest deregisterGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.
To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.
Learn more
- Parameters:
deregisterGameServerRequest
-- Returns:
- A Java Future containing the result of the DeregisterGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterGameServer
default CompletableFuture<DeregisterGameServerResponse> deregisterGameServer(Consumer<DeregisterGameServerRequest.Builder> deregisterGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.
To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.
Learn more
This is a convenience which creates an instance of the
DeregisterGameServerRequest.Builder
avoiding the need to create one manually viaDeregisterGameServerRequest.builder()
- Parameters:
deregisterGameServerRequest
- AConsumer
that will call methods onDeregisterGameServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlias
default CompletableFuture<DescribeAliasResponse> describeAlias(DescribeAliasRequest describeAliasRequest) Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use
ResolveAlias
.To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
Related actions
- Parameters:
describeAliasRequest
-- Returns:
- A Java Future containing the result of the DescribeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlias
default CompletableFuture<DescribeAliasResponse> describeAlias(Consumer<DescribeAliasRequest.Builder> describeAliasRequest) Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use
ResolveAlias
.To get alias properties, specify the alias ID. If successful, the requested alias record is returned.
Related actions
This is a convenience which creates an instance of the
DescribeAliasRequest.Builder
avoiding the need to create one manually viaDescribeAliasRequest.builder()
- Parameters:
describeAliasRequest
- AConsumer
that will call methods onDescribeAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBuild
default CompletableFuture<DescribeBuildResponse> describeBuild(DescribeBuildRequest describeBuildRequest) Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
- Parameters:
describeBuildRequest
-- Returns:
- A Java Future containing the result of the DescribeBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBuild
default CompletableFuture<DescribeBuildResponse> describeBuild(Consumer<DescribeBuildRequest.Builder> describeBuildRequest) Retrieves properties for a custom game build. To request a build resource, specify a build ID. If successful, an object containing the build properties is returned.
Learn more
This is a convenience which creates an instance of the
DescribeBuildRequest.Builder
avoiding the need to create one manually viaDescribeBuildRequest.builder()
- Parameters:
describeBuildRequest
- AConsumer
that will call methods onDescribeBuildRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeCompute
default CompletableFuture<DescribeComputeResponse> describeCompute(DescribeComputeRequest describeComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call ListCompute.
To request information on a specific compute, provide the fleet ID and compute name.
If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:
-
For
EC2
fleets, this operation returns information about the EC2 instance. -
For
ANYWHERE
fleets, this operation returns information about the registered compute. -
For
CONTAINER
fleets, this operation returns information about the container that's registered as a compute, and the instance it's running on. The compute name is the container name.
- Parameters:
describeComputeRequest
-- Returns:
- A Java Future containing the result of the DescribeCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeCompute
default CompletableFuture<DescribeComputeResponse> describeCompute(Consumer<DescribeComputeRequest.Builder> describeComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call ListCompute.
To request information on a specific compute, provide the fleet ID and compute name.
If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:
-
For
EC2
fleets, this operation returns information about the EC2 instance. -
For
ANYWHERE
fleets, this operation returns information about the registered compute. -
For
CONTAINER
fleets, this operation returns information about the container that's registered as a compute, and the instance it's running on. The compute name is the container name.
This is a convenience which creates an instance of the
DescribeComputeRequest.Builder
avoiding the need to create one manually viaDescribeComputeRequest.builder()
- Parameters:
describeComputeRequest
- AConsumer
that will call methods onDescribeComputeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeContainerGroupDefinition
default CompletableFuture<DescribeContainerGroupDefinitionResponse> describeContainerGroupDefinition(DescribeContainerGroupDefinitionRequest describeContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves the properties of a container group definition, including all container definitions in the group.
To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.
Learn more
- Parameters:
describeContainerGroupDefinitionRequest
-- Returns:
- A Java Future containing the result of the DescribeContainerGroupDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeContainerGroupDefinition
default CompletableFuture<DescribeContainerGroupDefinitionResponse> describeContainerGroupDefinition(Consumer<DescribeContainerGroupDefinitionRequest.Builder> describeContainerGroupDefinitionRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves the properties of a container group definition, including all container definitions in the group.
To retrieve a container group definition, provide a resource identifier. If successful, this operation returns the complete properties of the container group definition.
Learn more
This is a convenience which creates an instance of the
DescribeContainerGroupDefinitionRequest.Builder
avoiding the need to create one manually viaDescribeContainerGroupDefinitionRequest.builder()
- Parameters:
describeContainerGroupDefinitionRequest
- AConsumer
that will call methods onDescribeContainerGroupDefinitionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeContainerGroupDefinition operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEC2InstanceLimits
default CompletableFuture<DescribeEc2InstanceLimitsResponse> describeEC2InstanceLimits(DescribeEc2InstanceLimitsRequest describeEc2InstanceLimitsRequest) Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
-
Request specifies the Region
ap-northeast-1
with no location. The result is limits and usage data on all instance types that are deployed inus-east-2
, by all of the fleets that reside inap-northeast-1
. -
Request specifies the Region
us-east-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside inus-east-2
. These limits do not affect fleets in any other Regions that deploy instances toca-central-1
. -
Request specifies the Region
eu-west-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside ineu-west-1
.
This operation can be used in the following ways:
-
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
-
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an
EC2InstanceLimits
object is returned with limits and usage data for each requested instance type.Learn more
- Parameters:
describeEc2InstanceLimitsRequest
-- Returns:
- A Java Future containing the result of the DescribeEC2InstanceLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeEC2InstanceLimits
default CompletableFuture<DescribeEc2InstanceLimitsResponse> describeEC2InstanceLimits(Consumer<DescribeEc2InstanceLimitsRequest.Builder> describeEc2InstanceLimitsRequest) Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
-
Request specifies the Region
ap-northeast-1
with no location. The result is limits and usage data on all instance types that are deployed inus-east-2
, by all of the fleets that reside inap-northeast-1
. -
Request specifies the Region
us-east-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside inus-east-2
. These limits do not affect fleets in any other Regions that deploy instances toca-central-1
. -
Request specifies the Region
eu-west-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside ineu-west-1
.
This operation can be used in the following ways:
-
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
-
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an
EC2InstanceLimits
object is returned with limits and usage data for each requested instance type.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeEc2InstanceLimitsRequest.Builder
avoiding the need to create one manually viaDescribeEc2InstanceLimitsRequest.builder()
- Parameters:
describeEc2InstanceLimitsRequest
- AConsumer
that will call methods onDescribeEc2InstanceLimitsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEC2InstanceLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeEC2InstanceLimits
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
-
Request specifies the Region
ap-northeast-1
with no location. The result is limits and usage data on all instance types that are deployed inus-east-2
, by all of the fleets that reside inap-northeast-1
. -
Request specifies the Region
us-east-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside inus-east-2
. These limits do not affect fleets in any other Regions that deploy instances toca-central-1
. -
Request specifies the Region
eu-west-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside ineu-west-1
.
This operation can be used in the following ways:
-
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
-
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an
EC2InstanceLimits
object is returned with limits and usage data for each requested instance type.Learn more
- Returns:
- A Java Future containing the result of the DescribeEC2InstanceLimits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetAttributes
default CompletableFuture<DescribeFleetAttributesResponse> describeFleetAttributes(DescribeFleetAttributesRequest describeFleetAttributesRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
-
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
FleetAttributes
object is returned for each fleet requested, unless the fleet identifier is not found.Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
- Parameters:
describeFleetAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetAttributes
default CompletableFuture<DescribeFleetAttributesResponse> describeFleetAttributes(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
-
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
FleetAttributes
object is returned for each fleet requested, unless the fleet identifier is not found.Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetAttributesRequest.Builder
avoiding the need to create one manually viaDescribeFleetAttributesRequest.builder()
- Parameters:
describeFleetAttributesRequest
- AConsumer
that will call methods onDescribeFleetAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetAttributes
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
-
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
FleetAttributes
object is returned for each fleet requested, unless the fleet identifier is not found.Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
- Returns:
- A Java Future containing the result of the DescribeFleetAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetAttributesPaginator
This is a variant of
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesPublisher publisher = client.describeFleetAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesPublisher publisher = client.describeFleetAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetAttributesPaginator
default DescribeFleetAttributesPublisher describeFleetAttributesPaginator(DescribeFleetAttributesRequest describeFleetAttributesRequest) This is a variant of
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesPublisher publisher = client.describeFleetAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesPublisher publisher = client.describeFleetAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation.- Parameters:
describeFleetAttributesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetAttributesPaginator
default DescribeFleetAttributesPublisher describeFleetAttributesPaginator(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest) This is a variant of
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesPublisher publisher = client.describeFleetAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesPublisher publisher = client.describeFleetAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation.
This is a convenience which creates an instance of the
DescribeFleetAttributesRequest.Builder
avoiding the need to create one manually viaDescribeFleetAttributesRequest.builder()
- Parameters:
describeFleetAttributesRequest
- AConsumer
that will call methods onDescribeFleetAttributesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetCapacity
default CompletableFuture<DescribeFleetCapacityResponse> describeFleetCapacity(DescribeFleetCapacityRequest describeFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.
With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.
This operation can be used in the following ways:
-
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get capacity data for all fleets, do not provide a fleet identifier.
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. EachFleetCapacity
object includes aLocation
property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
- Parameters:
describeFleetCapacityRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetCapacity
default CompletableFuture<DescribeFleetCapacityResponse> describeFleetCapacity(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.
With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.
This operation can be used in the following ways:
-
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get capacity data for all fleets, do not provide a fleet identifier.
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. EachFleetCapacity
object includes aLocation
property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetCapacityRequest.Builder
avoiding the need to create one manually viaDescribeFleetCapacityRequest.builder()
- Parameters:
describeFleetCapacityRequest
- AConsumer
that will call methods onDescribeFleetCapacityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetCapacity
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for replica container groups.
With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.
This operation can be used in the following ways:
-
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get capacity data for all fleets, do not provide a fleet identifier.
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. EachFleetCapacity
object includes aLocation
property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
- Returns:
- A Java Future containing the result of the DescribeFleetCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetCapacityPaginator
This is a variant of
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityPublisher publisher = client.describeFleetCapacityPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityPublisher publisher = client.describeFleetCapacityPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetCapacityPaginator
default DescribeFleetCapacityPublisher describeFleetCapacityPaginator(DescribeFleetCapacityRequest describeFleetCapacityRequest) This is a variant of
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityPublisher publisher = client.describeFleetCapacityPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityPublisher publisher = client.describeFleetCapacityPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation.- Parameters:
describeFleetCapacityRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetCapacityPaginator
default DescribeFleetCapacityPublisher describeFleetCapacityPaginator(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest) This is a variant of
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityPublisher publisher = client.describeFleetCapacityPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityPublisher publisher = client.describeFleetCapacityPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation.
This is a convenience which creates an instance of the
DescribeFleetCapacityRequest.Builder
avoiding the need to create one manually viaDescribeFleetCapacityRequest.builder()
- Parameters:
describeFleetCapacityRequest
- AConsumer
that will call methods onDescribeFleetCapacityRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetEvents
default CompletableFuture<DescribeFleetEventsResponse> describeFleetEvents(DescribeFleetEventsRequest describeFleetEventsRequest) Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
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.
Learn more
- Parameters:
describeFleetEventsRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetEvents
default CompletableFuture<DescribeFleetEventsResponse> describeFleetEvents(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest) Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
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.
Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetEventsRequest.Builder
avoiding the need to create one manually viaDescribeFleetEventsRequest.builder()
- Parameters:
describeFleetEventsRequest
- AConsumer
that will call methods onDescribeFleetEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetEventsPaginator
default DescribeFleetEventsPublisher describeFleetEventsPaginator(DescribeFleetEventsRequest describeFleetEventsRequest) This is a variant of
describeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsPublisher publisher = client.describeFleetEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsPublisher publisher = client.describeFleetEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation.- Parameters:
describeFleetEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetEventsPaginator
default DescribeFleetEventsPublisher describeFleetEventsPaginator(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest) This is a variant of
describeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsPublisher publisher = client.describeFleetEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsPublisher publisher = client.describeFleetEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeFleetEventsRequest.Builder
avoiding the need to create one manually viaDescribeFleetEventsRequest.builder()
- Parameters:
describeFleetEventsRequest
- AConsumer
that will call methods onDescribeFleetEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetLocationAttributes
default CompletableFuture<DescribeFleetLocationAttributesResponse> describeFleetLocationAttributes(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest) Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
-
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
-
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
LocationAttributes
object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, callDescribeFleetAttributes
.Learn more
- Parameters:
describeFleetLocationAttributesRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetLocationAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetLocationAttributes
default CompletableFuture<DescribeFleetLocationAttributesResponse> describeFleetLocationAttributes(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest) Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
This operation can be used in the following ways:
-
To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.
-
To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.
When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
LocationAttributes
object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, callDescribeFleetAttributes
.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetLocationAttributesRequest.Builder
avoiding the need to create one manually viaDescribeFleetLocationAttributesRequest.builder()
- Parameters:
describeFleetLocationAttributesRequest
- AConsumer
that will call methods onDescribeFleetLocationAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetLocationAttributes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetLocationAttributesPaginator
default DescribeFleetLocationAttributesPublisher describeFleetLocationAttributesPaginator(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest) This is a variant of
describeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesPublisher publisher = client.describeFleetLocationAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesPublisher publisher = client.describeFleetLocationAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation.- Parameters:
describeFleetLocationAttributesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetLocationAttributesPaginator
default DescribeFleetLocationAttributesPublisher describeFleetLocationAttributesPaginator(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest) This is a variant of
describeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesPublisher publisher = client.describeFleetLocationAttributesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesPublisher publisher = client.describeFleetLocationAttributesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation.
This is a convenience which creates an instance of the
DescribeFleetLocationAttributesRequest.Builder
avoiding the need to create one manually viaDescribeFleetLocationAttributesRequest.builder()
- Parameters:
describeFleetLocationAttributesRequest
- AConsumer
that will call methods onDescribeFleetLocationAttributesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetLocationCapacity
default CompletableFuture<DescribeFleetLocationCapacityResponse> describeFleetLocationCapacity(DescribeFleetLocationCapacityRequest describeFleetLocationCapacityRequest) Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.
Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling
DescribeFleetCapacity
).To retrieve capacity data, identify a fleet and location.
If successful, a
FleetCapacity
object is returned for the requested fleet location.Learn more
- Parameters:
describeFleetLocationCapacityRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetLocationCapacity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetLocationCapacity
default CompletableFuture<DescribeFleetLocationCapacityResponse> describeFleetLocationCapacity(Consumer<DescribeFleetLocationCapacityRequest.Builder> describeFleetLocationCapacityRequest) Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.
Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling
DescribeFleetCapacity
).To retrieve capacity data, identify a fleet and location.
If successful, a
FleetCapacity
object is returned for the requested fleet location.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetLocationCapacityRequest.Builder
avoiding the need to create one manually viaDescribeFleetLocationCapacityRequest.builder()
- Parameters:
describeFleetLocationCapacityRequest
- AConsumer
that will call methods onDescribeFleetLocationCapacityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetLocationCapacity operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetLocationUtilization
default CompletableFuture<DescribeFleetLocationUtilizationResponse> describeFleetLocationUtilization(DescribeFleetLocationUtilizationRequest describeFleetLocationUtilizationRequest) Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling
DescribeFleetUtilization
).To retrieve utilization data, identify a fleet and location.
If successful, a
FleetUtilization
object is returned for the requested fleet location.Learn more
- Parameters:
describeFleetLocationUtilizationRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetLocationUtilization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetLocationUtilization
default CompletableFuture<DescribeFleetLocationUtilizationResponse> describeFleetLocationUtilization(Consumer<DescribeFleetLocationUtilizationRequest.Builder> describeFleetLocationUtilizationRequest) Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling
DescribeFleetUtilization
).To retrieve utilization data, identify a fleet and location.
If successful, a
FleetUtilization
object is returned for the requested fleet location.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetLocationUtilizationRequest.Builder
avoiding the need to create one manually viaDescribeFleetLocationUtilizationRequest.builder()
- Parameters:
describeFleetLocationUtilizationRequest
- AConsumer
that will call methods onDescribeFleetLocationUtilizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetLocationUtilization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetPortSettings
default CompletableFuture<DescribeFleetPortSettingsResponse> describeFleetPortSettings(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest) Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports.
Use this operation in the following ways:
-
To retrieve the port settings for a fleet, identify the fleet's unique identifier.
-
To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.
If successful, a set of
IpPermission
objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty.Learn more
- Parameters:
describeFleetPortSettingsRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetPortSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetPortSettings
default CompletableFuture<DescribeFleetPortSettingsResponse> describeFleetPortSettings(Consumer<DescribeFleetPortSettingsRequest.Builder> describeFleetPortSettingsRequest) Retrieves a fleet's inbound connection permissions. Connection permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a container fleet, the port settings should include one or more of the fleet's connection ports.
Use this operation in the following ways:
-
To retrieve the port settings for a fleet, identify the fleet's unique identifier.
-
To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.
If successful, a set of
IpPermission
objects is returned for the requested fleet ID. When specifying a location, this operation returns a pending status. If the requested fleet has been deleted, the result set is empty.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
DescribeFleetPortSettingsRequest.Builder
avoiding the need to create one manually viaDescribeFleetPortSettingsRequest.builder()
- Parameters:
describeFleetPortSettingsRequest
- AConsumer
that will call methods onDescribeFleetPortSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetPortSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetUtilization
default CompletableFuture<DescribeFleetUtilizationResponse> describeFleetUtilization(DescribeFleetUtilizationRequest describeFleetUtilizationRequest) Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
-
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get utilization data for all fleets, do not provide a fleet identifier.
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, unless the fleet identifier is not found. Each fleet utilization object includes a
Location
property, which is set to the fleet's home Region.Some API operations 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.
Learn more
- Parameters:
describeFleetUtilizationRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetUtilization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetUtilization
default CompletableFuture<DescribeFleetUtilizationResponse> describeFleetUtilization(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest) Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
-
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get utilization data for all fleets, do not provide a fleet identifier.
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, unless the fleet identifier is not found. Each fleet utilization object includes a
Location
property, which is set to the fleet's home Region.Some API operations 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.
Learn more
Setting up Amazon GameLift Fleets
This is a convenience which creates an instance of the
DescribeFleetUtilizationRequest.Builder
avoiding the need to create one manually viaDescribeFleetUtilizationRequest.builder()
- Parameters:
describeFleetUtilizationRequest
- AConsumer
that will call methods onDescribeFleetUtilizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetUtilization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetUtilization
Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
-
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get utilization data for all fleets, do not provide a fleet identifier.
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, unless the fleet identifier is not found. Each fleet utilization object includes a
Location
property, which is set to the fleet's home Region.Some API operations 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.
Learn more
- Returns:
- A Java Future containing the result of the DescribeFleetUtilization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeFleetUtilizationPaginator
This is a variant of
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationPublisher publisher = client.describeFleetUtilizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationPublisher publisher = client.describeFleetUtilizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetUtilizationPaginator
default DescribeFleetUtilizationPublisher describeFleetUtilizationPaginator(DescribeFleetUtilizationRequest describeFleetUtilizationRequest) This is a variant of
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationPublisher publisher = client.describeFleetUtilizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationPublisher publisher = client.describeFleetUtilizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation.- Parameters:
describeFleetUtilizationRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeFleetUtilizationPaginator
default DescribeFleetUtilizationPublisher describeFleetUtilizationPaginator(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest) This is a variant of
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationPublisher publisher = client.describeFleetUtilizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationPublisher publisher = client.describeFleetUtilizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation.
This is a convenience which creates an instance of the
DescribeFleetUtilizationRequest.Builder
avoiding the need to create one manually viaDescribeFleetUtilizationRequest.builder()
- Parameters:
describeFleetUtilizationRequest
- AConsumer
that will call methods onDescribeFleetUtilizationRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServer
default CompletableFuture<DescribeGameServerResponse> describeGameServer(DescribeGameServerRequest describeGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
- Parameters:
describeGameServerRequest
-- Returns:
- A Java Future containing the result of the DescribeGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServer
default CompletableFuture<DescribeGameServerResponse> describeGameServer(Consumer<DescribeGameServerRequest.Builder> describeGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
This is a convenience which creates an instance of the
DescribeGameServerRequest.Builder
avoiding the need to create one manually viaDescribeGameServerRequest.builder()
- Parameters:
describeGameServerRequest
- AConsumer
that will call methods onDescribeGameServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServerGroup
default CompletableFuture<DescribeGameServerGroupResponse> describeGameServerGroup(DescribeGameServerGroupRequest describeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.
To get attributes for a game server group, provide a group name or ARN value. If successful, a
GameServerGroup
object is returned.Learn more
- Parameters:
describeGameServerGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServerGroup
default CompletableFuture<DescribeGameServerGroupResponse> describeGameServerGroup(Consumer<DescribeGameServerGroupRequest.Builder> describeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.
To get attributes for a game server group, provide a group name or ARN value. If successful, a
GameServerGroup
object is returned.Learn more
This is a convenience which creates an instance of the
DescribeGameServerGroupRequest.Builder
avoiding the need to create one manually viaDescribeGameServerGroupRequest.builder()
- Parameters:
describeGameServerGroupRequest
- AConsumer
that will call methods onDescribeGameServerGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServerInstances
default CompletableFuture<DescribeGameServerInstancesResponse> describeGameServerInstances(DescribeGameServerInstancesRequest describeGameServerInstancesRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.
To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of
GameServerInstance
objects is returned.This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
- Parameters:
describeGameServerInstancesRequest
-- Returns:
- A Java Future containing the result of the DescribeGameServerInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServerInstances
default CompletableFuture<DescribeGameServerInstancesResponse> describeGameServerInstances(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.
To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of
GameServerInstance
objects is returned.This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
This is a convenience which creates an instance of the
DescribeGameServerInstancesRequest.Builder
avoiding the need to create one manually viaDescribeGameServerInstancesRequest.builder()
- Parameters:
describeGameServerInstancesRequest
- AConsumer
that will call methods onDescribeGameServerInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameServerInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServerInstancesPaginator
default DescribeGameServerInstancesPublisher describeGameServerInstancesPaginator(DescribeGameServerInstancesRequest describeGameServerInstancesRequest) This is a variant of
describeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesPublisher publisher = client.describeGameServerInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesPublisher publisher = client.describeGameServerInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation.- Parameters:
describeGameServerInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameServerInstancesPaginator
default DescribeGameServerInstancesPublisher describeGameServerInstancesPaginator(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest) This is a variant of
describeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesPublisher publisher = client.describeGameServerInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesPublisher publisher = client.describeGameServerInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeGameServerInstancesRequest.Builder
avoiding the need to create one manually viaDescribeGameServerInstancesRequest.builder()
- Parameters:
describeGameServerInstancesRequest
- AConsumer
that will call methods onDescribeGameServerInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionDetails
default CompletableFuture<DescribeGameSessionDetailsResponse> describeGameSessionDetails(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest) Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
-
To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
-
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
-
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSessionDetail
object is returned for each game session that matches the request.Learn more
- Parameters:
describeGameSessionDetailsRequest
-- Returns:
- A Java Future containing the result of the DescribeGameSessionDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeGameSessionDetails
default CompletableFuture<DescribeGameSessionDetailsResponse> describeGameSessionDetails(Consumer<DescribeGameSessionDetailsRequest.Builder> describeGameSessionDetailsRequest) Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
-
To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
-
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
-
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSessionDetail
object is returned for each game session that matches the request.Learn more
This is a convenience which creates an instance of the
DescribeGameSessionDetailsRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionDetailsRequest.builder()
- Parameters:
describeGameSessionDetailsRequest
- AConsumer
that will call methods onDescribeGameSessionDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameSessionDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeGameSessionDetailsPaginator
default DescribeGameSessionDetailsPublisher describeGameSessionDetailsPaginator(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest) This is a variant of
describeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsPublisher publisher = client.describeGameSessionDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsPublisher publisher = client.describeGameSessionDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation.- Parameters:
describeGameSessionDetailsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionDetailsPaginator
default DescribeGameSessionDetailsPublisher describeGameSessionDetailsPaginator(Consumer<DescribeGameSessionDetailsRequest.Builder> describeGameSessionDetailsRequest) This is a variant of
describeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsPublisher publisher = client.describeGameSessionDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsPublisher publisher = client.describeGameSessionDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation.
This is a convenience which creates an instance of the
DescribeGameSessionDetailsRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionDetailsRequest.builder()
- Parameters:
describeGameSessionDetailsRequest
- AConsumer
that will call methods onDescribeGameSessionDetailsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionPlacement
default CompletableFuture<DescribeGameSessionPlacementResponse> describeGameSessionPlacement(DescribeGameSessionPlacementRequest describeGameSessionPlacementRequest) Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with
DescribeGameSessionPlacement
should only be used for games in development with low game session usage.- Parameters:
describeGameSessionPlacementRequest
-- Returns:
- A Java Future containing the result of the DescribeGameSessionPlacement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionPlacement
default CompletableFuture<DescribeGameSessionPlacementResponse> describeGameSessionPlacement(Consumer<DescribeGameSessionPlacementRequest.Builder> describeGameSessionPlacementRequest) Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID.
This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with
DescribeGameSessionPlacement
should only be used for games in development with low game session usage.
This is a convenience which creates an instance of the
DescribeGameSessionPlacementRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionPlacementRequest.builder()
- Parameters:
describeGameSessionPlacementRequest
- AConsumer
that will call methods onDescribeGameSessionPlacementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameSessionPlacement operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionQueues
default CompletableFuture<DescribeGameSessionQueuesResponse> describeGameSessionQueues(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest) Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
- Parameters:
describeGameSessionQueuesRequest
-- Returns:
- A Java Future containing the result of the DescribeGameSessionQueues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionQueues
default CompletableFuture<DescribeGameSessionQueuesResponse> describeGameSessionQueues(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest) Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
This is a convenience which creates an instance of the
DescribeGameSessionQueuesRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionQueuesRequest.builder()
- Parameters:
describeGameSessionQueuesRequest
- AConsumer
that will call methods onDescribeGameSessionQueuesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameSessionQueues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionQueues
Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.
Learn more
- Returns:
- A Java Future containing the result of the DescribeGameSessionQueues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionQueuesPaginator
This is a variant of
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesPublisher publisher = client.describeGameSessionQueuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesPublisher publisher = client.describeGameSessionQueuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionQueuesPaginator
default DescribeGameSessionQueuesPublisher describeGameSessionQueuesPaginator(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest) This is a variant of
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesPublisher publisher = client.describeGameSessionQueuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesPublisher publisher = client.describeGameSessionQueuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation.- Parameters:
describeGameSessionQueuesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionQueuesPaginator
default DescribeGameSessionQueuesPublisher describeGameSessionQueuesPaginator(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest) This is a variant of
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesPublisher publisher = client.describeGameSessionQueuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesPublisher publisher = client.describeGameSessionQueuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation.
This is a convenience which creates an instance of the
DescribeGameSessionQueuesRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionQueuesRequest.builder()
- Parameters:
describeGameSessionQueuesRequest
- AConsumer
that will call methods onDescribeGameSessionQueuesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessions
default CompletableFuture<DescribeGameSessionsResponse> describeGameSessions(DescribeGameSessionsRequest describeGameSessionsRequest) Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
-
To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.
-
To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
-
To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSession
object is returned for each game session that matches the request.This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with
DescribeGameSessions
should only be used for games in development with low game session usage.Available in Amazon GameLift Local.
Learn more
- Parameters:
describeGameSessionsRequest
-- Returns:
- A Java Future containing the result of the DescribeGameSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeGameSessions
default CompletableFuture<DescribeGameSessionsResponse> describeGameSessions(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest) Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
-
To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.
-
To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
-
To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSession
object is returned for each game session that matches the request.This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with
DescribeGameSessions
should only be used for games in development with low game session usage.Available in Amazon GameLift Local.
Learn more
This is a convenience which creates an instance of the
DescribeGameSessionsRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionsRequest.builder()
- Parameters:
describeGameSessionsRequest
- AConsumer
that will call methods onDescribeGameSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeGameSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeGameSessionsPaginator
default DescribeGameSessionsPublisher describeGameSessionsPaginator(DescribeGameSessionsRequest describeGameSessionsRequest) This is a variant of
describeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsPublisher publisher = client.describeGameSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsPublisher publisher = client.describeGameSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation.- Parameters:
describeGameSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeGameSessionsPaginator
default DescribeGameSessionsPublisher describeGameSessionsPaginator(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest) This is a variant of
describeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsPublisher publisher = client.describeGameSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsPublisher publisher = client.describeGameSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeGameSessionsRequest.Builder
avoiding the need to create one manually viaDescribeGameSessionsRequest.builder()
- Parameters:
describeGameSessionsRequest
- AConsumer
that will call methods onDescribeGameSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInstances
default CompletableFuture<DescribeInstancesResponse> describeInstances(DescribeInstancesRequest describeInstancesRequest) Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.
You can call this operation in the following ways:
-
To get information on all instances in a fleet's home Region, specify the fleet ID.
-
To get information on all instances in a fleet's remote location, specify the fleet ID and location name.
-
To get information on a specific instance in a fleet, specify the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns
Instance
objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException.Learn more
Remotely connect to fleet instances
Related actions
- Parameters:
describeInstancesRequest
-- Returns:
- A Java Future containing the result of the DescribeInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeInstances
default CompletableFuture<DescribeInstancesResponse> describeInstances(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.
You can call this operation in the following ways:
-
To get information on all instances in a fleet's home Region, specify the fleet ID.
-
To get information on all instances in a fleet's remote location, specify the fleet ID and location name.
-
To get information on a specific instance in a fleet, specify the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns
Instance
objects for each requested instance, listed in no particular order. If you call this operation for an Anywhere fleet, you receive an InvalidRequestException.Learn more
Remotely connect to fleet instances
Related actions
This is a convenience which creates an instance of the
DescribeInstancesRequest.Builder
avoiding the need to create one manually viaDescribeInstancesRequest.builder()
- Parameters:
describeInstancesRequest
- AConsumer
that will call methods onDescribeInstancesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeInstancesPaginator
default DescribeInstancesPublisher describeInstancesPaginator(DescribeInstancesRequest describeInstancesRequest) This is a variant of
describeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeInstancesPublisher publisher = client.describeInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesPublisher publisher = client.describeInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeInstancesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest)
operation.- Parameters:
describeInstancesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInstancesPaginator
default DescribeInstancesPublisher describeInstancesPaginator(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) This is a variant of
describeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeInstancesPublisher publisher = client.describeInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesPublisher publisher = client.describeInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeInstancesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeInstancesRequest.Builder
avoiding the need to create one manually viaDescribeInstancesRequest.builder()
- Parameters:
describeInstancesRequest
- AConsumer
that will call methods onDescribeInstancesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmaking
default CompletableFuture<DescribeMatchmakingResponse> describeMatchmaking(DescribeMatchmakingRequest describeMatchmakingRequest) Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.
Learn more
- Parameters:
describeMatchmakingRequest
-- Returns:
- A Java Future containing the result of the DescribeMatchmaking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmaking
default CompletableFuture<DescribeMatchmakingResponse> describeMatchmaking(Consumer<DescribeMatchmakingRequest.Builder> describeMatchmakingRequest) Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
This is a convenience which creates an instance of the
DescribeMatchmakingRequest.Builder
avoiding the need to create one manually viaDescribeMatchmakingRequest.builder()
- Parameters:
describeMatchmakingRequest
- AConsumer
that will call methods onDescribeMatchmakingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMatchmaking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingConfigurations
default CompletableFuture<DescribeMatchmakingConfigurationsResponse> describeMatchmakingConfigurations(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest) Retrieves the details of FlexMatch matchmaking configurations.
This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
- Parameters:
describeMatchmakingConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeMatchmakingConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingConfigurations
default CompletableFuture<DescribeMatchmakingConfigurationsResponse> describeMatchmakingConfigurations(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest) Retrieves the details of FlexMatch matchmaking configurations.
This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
Setting up FlexMatch matchmakers
This is a convenience which creates an instance of the
DescribeMatchmakingConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeMatchmakingConfigurationsRequest.builder()
- Parameters:
describeMatchmakingConfigurationsRequest
- AConsumer
that will call methods onDescribeMatchmakingConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMatchmakingConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingConfigurations
default CompletableFuture<DescribeMatchmakingConfigurationsResponse> describeMatchmakingConfigurations()Retrieves the details of FlexMatch matchmaking configurations.
This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
- Returns:
- A Java Future containing the result of the DescribeMatchmakingConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingConfigurationsPaginator
This is a variant of
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsPublisher publisher = client.describeMatchmakingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsPublisher publisher = client.describeMatchmakingConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingConfigurationsPaginator
default DescribeMatchmakingConfigurationsPublisher describeMatchmakingConfigurationsPaginator(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest) This is a variant of
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsPublisher publisher = client.describeMatchmakingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsPublisher publisher = client.describeMatchmakingConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation.- Parameters:
describeMatchmakingConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingConfigurationsPaginator
default DescribeMatchmakingConfigurationsPublisher describeMatchmakingConfigurationsPaginator(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest) This is a variant of
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsPublisher publisher = client.describeMatchmakingConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsPublisher publisher = client.describeMatchmakingConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeMatchmakingConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeMatchmakingConfigurationsRequest.builder()
- Parameters:
describeMatchmakingConfigurationsRequest
- AConsumer
that will call methods onDescribeMatchmakingConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingRuleSets
default CompletableFuture<DescribeMatchmakingRuleSetsResponse> describeMatchmakingRuleSets(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest) Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
- Parameters:
describeMatchmakingRuleSetsRequest
-- Returns:
- A Java Future containing the result of the DescribeMatchmakingRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingRuleSets
default CompletableFuture<DescribeMatchmakingRuleSetsResponse> describeMatchmakingRuleSets(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest) Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
This is a convenience which creates an instance of the
DescribeMatchmakingRuleSetsRequest.Builder
avoiding the need to create one manually viaDescribeMatchmakingRuleSetsRequest.builder()
- Parameters:
describeMatchmakingRuleSetsRequest
- AConsumer
that will call methods onDescribeMatchmakingRuleSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMatchmakingRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingRuleSets
Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.
Learn more
- Returns:
- A Java Future containing the result of the DescribeMatchmakingRuleSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingRuleSetsPaginator
This is a variant of
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsPublisher publisher = client.describeMatchmakingRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsPublisher publisher = client.describeMatchmakingRuleSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingRuleSetsPaginator
default DescribeMatchmakingRuleSetsPublisher describeMatchmakingRuleSetsPaginator(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest) This is a variant of
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsPublisher publisher = client.describeMatchmakingRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsPublisher publisher = client.describeMatchmakingRuleSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation.- Parameters:
describeMatchmakingRuleSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeMatchmakingRuleSetsPaginator
default DescribeMatchmakingRuleSetsPublisher describeMatchmakingRuleSetsPaginator(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest) This is a variant of
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsPublisher publisher = client.describeMatchmakingRuleSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsPublisher publisher = client.describeMatchmakingRuleSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation.
This is a convenience which creates an instance of the
DescribeMatchmakingRuleSetsRequest.Builder
avoiding the need to create one manually viaDescribeMatchmakingRuleSetsRequest.builder()
- Parameters:
describeMatchmakingRuleSetsRequest
- AConsumer
that will call methods onDescribeMatchmakingRuleSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePlayerSessions
default CompletableFuture<DescribePlayerSessionsResponse> describePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest) Retrieves properties for one or more player sessions.
This action can be used in the following ways:
-
To retrieve a specific player session, provide the player session ID only.
-
To retrieve all player sessions in a game session, provide the game session ID only.
-
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific
PlayerSessionId
orPlayerId
, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages.If successful, a
PlayerSession
object is returned for each session that matches the request.Related actions
- Parameters:
describePlayerSessionsRequest
-- Returns:
- A Java Future containing the result of the DescribePlayerSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describePlayerSessions
default CompletableFuture<DescribePlayerSessionsResponse> describePlayerSessions(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest) Retrieves properties for one or more player sessions.
This action can be used in the following ways:
-
To retrieve a specific player session, provide the player session ID only.
-
To retrieve all player sessions in a game session, provide the game session ID only.
-
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. If you provide a specific
PlayerSessionId
orPlayerId
, Amazon GameLift ignores the filter criteria. Use the pagination parameters to retrieve results as a set of sequential pages.If successful, a
PlayerSession
object is returned for each session that matches the request.Related actions
This is a convenience which creates an instance of the
DescribePlayerSessionsRequest.Builder
avoiding the need to create one manually viaDescribePlayerSessionsRequest.builder()
- Parameters:
describePlayerSessionsRequest
- AConsumer
that will call methods onDescribePlayerSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePlayerSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describePlayerSessionsPaginator
default DescribePlayerSessionsPublisher describePlayerSessionsPaginator(DescribePlayerSessionsRequest describePlayerSessionsRequest) This is a variant of
describePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsPublisher publisher = client.describePlayerSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsPublisher publisher = client.describePlayerSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation.- Parameters:
describePlayerSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePlayerSessionsPaginator
default DescribePlayerSessionsPublisher describePlayerSessionsPaginator(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest) This is a variant of
describePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsPublisher publisher = client.describePlayerSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsPublisher publisher = client.describePlayerSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation.
This is a convenience which creates an instance of the
DescribePlayerSessionsRequest.Builder
avoiding the need to create one manually viaDescribePlayerSessionsRequest.builder()
- Parameters:
describePlayerSessionsRequest
- AConsumer
that will call methods onDescribePlayerSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRuntimeConfiguration
default CompletableFuture<DescribeRuntimeConfigurationResponse> describeRuntimeConfiguration(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest) Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. For container fleets, the runtime configuration describes server processes that run in each replica container group. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.
To get the current runtime configuration for a fleet, provide the fleet ID.
If successful, a
RuntimeConfiguration
object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.Learn more
- Parameters:
describeRuntimeConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeRuntimeConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRuntimeConfiguration
default CompletableFuture<DescribeRuntimeConfigurationResponse> describeRuntimeConfiguration(Consumer<DescribeRuntimeConfigurationRequest.Builder> describeRuntimeConfigurationRequest) Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. For container fleets, the runtime configuration describes server processes that run in each replica container group. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.
To get the current runtime configuration for a fleet, provide the fleet ID.
If successful, a
RuntimeConfiguration
object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.Learn more
Setting up Amazon GameLift fleets
Running multiple processes on a fleet
This is a convenience which creates an instance of the
DescribeRuntimeConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeRuntimeConfigurationRequest.builder()
- Parameters:
describeRuntimeConfigurationRequest
- AConsumer
that will call methods onDescribeRuntimeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRuntimeConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScalingPolicies
default CompletableFuture<DescribeScalingPoliciesResponse> 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.A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.
- Parameters:
describeScalingPoliciesRequest
-- Returns:
- A Java Future containing the result of the DescribeScalingPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScalingPolicies
default CompletableFuture<DescribeScalingPoliciesResponse> describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> 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.A fleet may have all of its scaling policies suspended. This operation does not affect the status of the scaling policies, which remains ACTIVE.
This is a convenience which creates an instance of the
DescribeScalingPoliciesRequest.Builder
avoiding the need to create one manually viaDescribeScalingPoliciesRequest.builder()
- Parameters:
describeScalingPoliciesRequest
- AConsumer
that will call methods onDescribeScalingPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeScalingPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScalingPoliciesPaginator
default DescribeScalingPoliciesPublisher describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) This is a variant of
describeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesPublisher publisher = client.describeScalingPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesPublisher publisher = client.describeScalingPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation.- Parameters:
describeScalingPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScalingPoliciesPaginator
default DescribeScalingPoliciesPublisher describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) This is a variant of
describeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesPublisher publisher = client.describeScalingPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesPublisher publisher = client.describeScalingPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation.
This is a convenience which creates an instance of the
DescribeScalingPoliciesRequest.Builder
avoiding the need to create one manually viaDescribeScalingPoliciesRequest.builder()
- Parameters:
describeScalingPoliciesRequest
- AConsumer
that will call methods onDescribeScalingPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScript
default CompletableFuture<DescribeScriptResponse> describeScript(DescribeScriptRequest describeScriptRequest) Retrieves properties for a Realtime script.
To request a script record, specify the script ID. If successful, an object containing the script properties is returned.
Learn more
Amazon GameLift Realtime Servers
Related actions
- Parameters:
describeScriptRequest
-- Returns:
- A Java Future containing the result of the DescribeScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeScript
default CompletableFuture<DescribeScriptResponse> describeScript(Consumer<DescribeScriptRequest.Builder> describeScriptRequest) Retrieves properties for a Realtime script.
To request a script record, specify the script ID. If successful, an object containing the script properties is returned.
Learn more
Amazon GameLift Realtime Servers
Related actions
This is a convenience which creates an instance of the
DescribeScriptRequest.Builder
avoiding the need to create one manually viaDescribeScriptRequest.builder()
- Parameters:
describeScriptRequest
- AConsumer
that will call methods onDescribeScriptRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcPeeringAuthorizations
default CompletableFuture<DescribeVpcPeeringAuthorizationsResponse> describeVpcPeeringAuthorizations(DescribeVpcPeeringAuthorizationsRequest describeVpcPeeringAuthorizationsRequest) Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.
Related actions
- Parameters:
describeVpcPeeringAuthorizationsRequest
-- Returns:
- A Java Future containing the result of the DescribeVpcPeeringAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcPeeringAuthorizations
default CompletableFuture<DescribeVpcPeeringAuthorizationsResponse> describeVpcPeeringAuthorizations(Consumer<DescribeVpcPeeringAuthorizationsRequest.Builder> describeVpcPeeringAuthorizationsRequest) Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.
Related actions
This is a convenience which creates an instance of the
DescribeVpcPeeringAuthorizationsRequest.Builder
avoiding the need to create one manually viaDescribeVpcPeeringAuthorizationsRequest.builder()
- Parameters:
describeVpcPeeringAuthorizationsRequest
- AConsumer
that will call methods onDescribeVpcPeeringAuthorizationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeVpcPeeringAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcPeeringAuthorizations
default CompletableFuture<DescribeVpcPeeringAuthorizationsResponse> describeVpcPeeringAuthorizations()Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.
Related actions
- Returns:
- A Java Future containing the result of the DescribeVpcPeeringAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcPeeringConnections
default CompletableFuture<DescribeVpcPeeringConnectionsResponse> describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest) Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.
To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.
Related actions
- Parameters:
describeVpcPeeringConnectionsRequest
-- Returns:
- A Java Future containing the result of the DescribeVpcPeeringConnections operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcPeeringConnections
default CompletableFuture<DescribeVpcPeeringConnectionsResponse> describeVpcPeeringConnections(Consumer<DescribeVpcPeeringConnectionsRequest.Builder> describeVpcPeeringConnectionsRequest) Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.
To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.
Related actions
This is a convenience which creates an instance of the
DescribeVpcPeeringConnectionsRequest.Builder
avoiding the need to create one manually viaDescribeVpcPeeringConnectionsRequest.builder()
- Parameters:
describeVpcPeeringConnectionsRequest
- AConsumer
that will call methods onDescribeVpcPeeringConnectionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeVpcPeeringConnections operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVpcPeeringConnections
Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.
To retrieve connection information, call this operation from the Amazon Web Services account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.
Related actions
- Returns:
- A Java Future containing the result of the DescribeVpcPeeringConnections operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComputeAccess
default CompletableFuture<GetComputeAccessResponse> getComputeAccess(GetComputeAccessRequest getComputeAccessRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets
To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.
EC2 fleets
With an EC2 fleet (where compute type is
EC2
), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.Container fleets
With a container fleet (where compute type is
CONTAINER
), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container.Learn more
- Parameters:
getComputeAccessRequest
-- Returns:
- A Java Future containing the result of the GetComputeAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComputeAccess
default CompletableFuture<GetComputeAccessResponse> getComputeAccess(Consumer<GetComputeAccessRequest.Builder> getComputeAccessRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets
To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.
EC2 fleets
With an EC2 fleet (where compute type is
EC2
), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.Container fleets
With a container fleet (where compute type is
CONTAINER
), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you're connected to the instance, use Docker commands to interact with the container.Learn more
This is a convenience which creates an instance of the
GetComputeAccessRequest.Builder
avoiding the need to create one manually viaGetComputeAccessRequest.builder()
- Parameters:
getComputeAccessRequest
- AConsumer
that will call methods onGetComputeAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComputeAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComputeAuthToken
default CompletableFuture<GetComputeAuthTokenResponse> getComputeAuthToken(GetComputeAuthTokenRequest getComputeAuthTokenRequest) Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action
InitSDK()
. Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires.Use this operation based on the fleet compute type:
-
For
EC2
fleets, auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token. -
For
ANYWHERE
andCONTAINER
fleets, if you're using the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any container or Anywhere compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes.
Learn more
-
Server SDK reference guides (for version 5.x)
- Parameters:
getComputeAuthTokenRequest
-- Returns:
- A Java Future containing the result of the GetComputeAuthToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getComputeAuthToken
default CompletableFuture<GetComputeAuthTokenResponse> getComputeAuthToken(Consumer<GetComputeAuthTokenRequest.Builder> getComputeAuthTokenRequest) Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift Anywhere fleet or container fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server SDK action
InitSDK()
. Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires.Use this operation based on the fleet compute type:
-
For
EC2
fleets, auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token. -
For
ANYWHERE
andCONTAINER
fleets, if you're using the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for any container or Anywhere compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes.
Learn more
-
Server SDK reference guides (for version 5.x)
This is a convenience which creates an instance of the
GetComputeAuthTokenRequest.Builder
avoiding the need to create one manually viaGetComputeAuthTokenRequest.builder()
- Parameters:
getComputeAuthTokenRequest
- AConsumer
that will call methods onGetComputeAuthTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComputeAuthToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getGameSessionLogUrl
default CompletableFuture<GetGameSessionLogUrlResponse> getGameSessionLogUrl(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest) Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.
See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
- Parameters:
getGameSessionLogUrlRequest
-- Returns:
- A Java Future containing the result of the GetGameSessionLogUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGameSessionLogUrl
default CompletableFuture<GetGameSessionLogUrlResponse> getGameSessionLogUrl(Consumer<GetGameSessionLogUrlRequest.Builder> getGameSessionLogUrlRequest) Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.
See the Amazon Web Services Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
This is a convenience which creates an instance of the
GetGameSessionLogUrlRequest.Builder
avoiding the need to create one manually viaGetGameSessionLogUrlRequest.builder()
- Parameters:
getGameSessionLogUrlRequest
- AConsumer
that will call methods onGetGameSessionLogUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGameSessionLogUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInstanceAccess
default CompletableFuture<GetInstanceAccessResponse> getInstanceAccess(GetInstanceAccessRequest getInstanceAccessRequest) Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call GetComputeAccess.
To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling DescribeInstances with the fleet ID.
If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows:
-
For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client.
-
For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a
.pem
file. If you're using the CLI, see the example Get credentials for a Linux instance for tips on automatically saving the secret to a.pem
file.
Learn more
Remotely connect to fleet instances
Related actions
- Parameters:
getInstanceAccessRequest
-- Returns:
- A Java Future containing the result of the GetInstanceAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getInstanceAccess
default CompletableFuture<GetInstanceAccessResponse> getInstanceAccess(Consumer<GetInstanceAccessRequest.Builder> getInstanceAccessRequest) Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet. Use this operation to connect to instances with game servers that use Amazon GameLift server SDK 4.x or earlier. To connect to instances with game servers that use server SDK 5.x or later, call GetComputeAccess.
To request access to an instance, specify IDs for the instance and the fleet it belongs to. You can retrieve instance IDs for a fleet by calling DescribeInstances with the fleet ID.
If successful, this operation returns an IP address and credentials. The returned credentials match the operating system of the instance, as follows:
-
For a Windows instance: returns a user name and secret (password) for use with a Windows Remote Desktop client.
-
For a Linux instance: returns a user name and secret (RSA private key) for use with an SSH client. You must save the secret to a
.pem
file. If you're using the CLI, see the example Get credentials for a Linux instance for tips on automatically saving the secret to a.pem
file.
Learn more
Remotely connect to fleet instances
Related actions
This is a convenience which creates an instance of the
GetInstanceAccessRequest.Builder
avoiding the need to create one manually viaGetInstanceAccessRequest.builder()
- Parameters:
getInstanceAccessRequest
- AConsumer
that will call methods onGetInstanceAccessRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInstanceAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listAliases
Retrieves all aliases for this Amazon Web Services 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.
Returned aliases are not listed in any particular order.
Related actions
- Parameters:
listAliasesRequest
-- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliases
default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) Retrieves all aliases for this Amazon Web Services 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.
Returned aliases are not listed in any particular order.
Related actions
This is a convenience which creates an instance of the
ListAliasesRequest.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliases
Retrieves all aliases for this Amazon Web Services 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.
Returned aliases are not listed in any particular order.
Related actions
- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliasesPaginator
This is a variant of
listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListAliasesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliasesPaginator
This is a variant of
listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListAliasesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation.- Parameters:
listAliasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAliasesPaginator
default ListAliasesPublisher listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) This is a variant of
listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListAliasesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation.
This is a convenience which creates an instance of the
ListAliasesRequest.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBuilds
Retrieves build resources for all builds associated with the Amazon Web Services 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 resources are not listed in any particular order.
Learn more
- Parameters:
listBuildsRequest
-- Returns:
- A Java Future containing the result of the ListBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBuilds
default CompletableFuture<ListBuildsResponse> listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest) Retrieves build resources for all builds associated with the Amazon Web Services 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 resources are not listed in any particular order.
Learn more
This is a convenience which creates an instance of the
ListBuildsRequest.Builder
avoiding the need to create one manually viaListBuildsRequest.builder()
- Parameters:
listBuildsRequest
- AConsumer
that will call methods onListBuildsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBuilds
Retrieves build resources for all builds associated with the Amazon Web Services 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 resources are not listed in any particular order.
Learn more
- Returns:
- A Java Future containing the result of the ListBuilds operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBuildsPaginator
This is a variant of
listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListBuildsPublisher publisher = client.listBuildsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListBuildsPublisher publisher = client.listBuildsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListBuildsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListBuildsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBuildsPaginator
This is a variant of
listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListBuildsPublisher publisher = client.listBuildsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListBuildsPublisher publisher = client.listBuildsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListBuildsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListBuildsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation.- Parameters:
listBuildsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBuildsPaginator
default ListBuildsPublisher listBuildsPaginator(Consumer<ListBuildsRequest.Builder> listBuildsRequest) This is a variant of
listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListBuildsPublisher publisher = client.listBuildsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListBuildsPublisher publisher = client.listBuildsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListBuildsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListBuildsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation.
This is a convenience which creates an instance of the
ListBuildsRequest.Builder
avoiding the need to create one manually viaListBuildsRequest.builder()
- Parameters:
listBuildsRequest
- AConsumer
that will call methods onListBuildsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCompute
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves information on the compute resources in an Amazon GameLift fleet.
To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages.
You can filter the result set by location.
If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information:
-
For
EC2
fleets, this operation returns information about the EC2 instance. Compute names are instance IDs. -
For
ANYWHERE
fleets, this operation returns the compute names and details provided when the compute was registered withRegisterCompute
. TheGameLiftServiceSdkEndpoint
orGameLiftAgentEndpoint
is included. -
For
CONTAINER
fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names.
- Parameters:
listComputeRequest
-- Returns:
- A Java Future containing the result of the ListCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listCompute
default CompletableFuture<ListComputeResponse> listCompute(Consumer<ListComputeRequest.Builder> listComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves information on the compute resources in an Amazon GameLift fleet.
To request a list of computes, specify the fleet ID. Use the pagination parameters to retrieve results in a set of sequential pages.
You can filter the result set by location.
If successful, this operation returns information on all computes in the requested fleet. Depending on the fleet's compute type, the result includes the following information:
-
For
EC2
fleets, this operation returns information about the EC2 instance. Compute names are instance IDs. -
For
ANYWHERE
fleets, this operation returns the compute names and details provided when the compute was registered withRegisterCompute
. TheGameLiftServiceSdkEndpoint
orGameLiftAgentEndpoint
is included. -
For
CONTAINER
fleets, this operation returns information about containers that are registered as computes, and the instances they're running on. Compute names are container names.
This is a convenience which creates an instance of the
ListComputeRequest.Builder
avoiding the need to create one manually viaListComputeRequest.builder()
- Parameters:
listComputeRequest
- AConsumer
that will call methods onListComputeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listComputePaginator
This is a variant of
listCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListComputePublisher publisher = client.listComputePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListComputePublisher publisher = client.listComputePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListComputeResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListComputeResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation.- Parameters:
listComputeRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComputePaginator
default ListComputePublisher listComputePaginator(Consumer<ListComputeRequest.Builder> listComputeRequest) This is a variant of
listCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListComputePublisher publisher = client.listComputePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListComputePublisher publisher = client.listComputePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListComputeResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListComputeResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation.
This is a convenience which creates an instance of the
ListComputeRequest.Builder
avoiding the need to create one manually viaListComputeRequest.builder()
- Parameters:
listComputeRequest
- AConsumer
that will call methods onListComputeRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContainerGroupDefinitions
default CompletableFuture<ListContainerGroupDefinitionsResponse> listContainerGroupDefinitions(ListContainerGroupDefinitionsRequest listContainerGroupDefinitionsRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of sequential pages.
This operation returns the list of container group definitions in no particular order.
Learn more
- Parameters:
listContainerGroupDefinitionsRequest
-- Returns:
- A Java Future containing the result of the ListContainerGroupDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContainerGroupDefinitions
default CompletableFuture<ListContainerGroupDefinitionsResponse> listContainerGroupDefinitions(Consumer<ListContainerGroupDefinitionsRequest.Builder> listContainerGroupDefinitionsRequest) This operation is used with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of sequential pages.
This operation returns the list of container group definitions in no particular order.
Learn more
This is a convenience which creates an instance of the
ListContainerGroupDefinitionsRequest.Builder
avoiding the need to create one manually viaListContainerGroupDefinitionsRequest.builder()
- Parameters:
listContainerGroupDefinitionsRequest
- AConsumer
that will call methods onListContainerGroupDefinitionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListContainerGroupDefinitions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContainerGroupDefinitionsPaginator
default ListContainerGroupDefinitionsPublisher listContainerGroupDefinitionsPaginator(ListContainerGroupDefinitionsRequest listContainerGroupDefinitionsRequest) This is a variant of
listContainerGroupDefinitions(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListContainerGroupDefinitionsPublisher publisher = client.listContainerGroupDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListContainerGroupDefinitionsPublisher publisher = client.listContainerGroupDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainerGroupDefinitions(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsRequest)
operation.- Parameters:
listContainerGroupDefinitionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContainerGroupDefinitionsPaginator
default ListContainerGroupDefinitionsPublisher listContainerGroupDefinitionsPaginator(Consumer<ListContainerGroupDefinitionsRequest.Builder> listContainerGroupDefinitionsRequest) This is a variant of
listContainerGroupDefinitions(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListContainerGroupDefinitionsPublisher publisher = client.listContainerGroupDefinitionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListContainerGroupDefinitionsPublisher publisher = client.listContainerGroupDefinitionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainerGroupDefinitions(software.amazon.awssdk.services.gamelift.model.ListContainerGroupDefinitionsRequest)
operation.
This is a convenience which creates an instance of the
ListContainerGroupDefinitionsRequest.Builder
avoiding the need to create one manually viaListContainerGroupDefinitionsRequest.builder()
- Parameters:
listContainerGroupDefinitionsRequest
- AConsumer
that will call methods onListContainerGroupDefinitionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFleets
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
You can use operation in the following ways:
-
To get a list of all fleets in a Region, don't provide a build or script identifier.
-
To get a list of all fleets where a specific game build is deployed, provide the build ID.
-
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.
-
To get a list of all fleets with a specific container group definition, provide the
ContainerGroupDefinition
ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.
Fleet IDs are returned in no particular order.
- Parameters:
listFleetsRequest
-- Returns:
- A Java Future containing the result of the ListFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listFleets
default CompletableFuture<ListFleetsResponse> listFleets(Consumer<ListFleetsRequest.Builder> listFleetsRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
You can use operation in the following ways:
-
To get a list of all fleets in a Region, don't provide a build or script identifier.
-
To get a list of all fleets where a specific game build is deployed, provide the build ID.
-
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.
-
To get a list of all fleets with a specific container group definition, provide the
ContainerGroupDefinition
ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.
Fleet IDs are returned in no particular order.
This is a convenience which creates an instance of the
ListFleetsRequest.Builder
avoiding the need to create one manually viaListFleetsRequest.builder()
- Parameters:
listFleetsRequest
- AConsumer
that will call methods onListFleetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listFleets
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.
You can use operation in the following ways:
-
To get a list of all fleets in a Region, don't provide a build or script identifier.
-
To get a list of all fleets where a specific game build is deployed, provide the build ID.
-
To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.
-
To get a list of all fleets with a specific container group definition, provide the
ContainerGroupDefinition
ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.
Fleet IDs are returned in no particular order.
- Returns:
- A Java Future containing the result of the ListFleets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listFleetsPaginator
This is a variant of
listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListFleetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListFleetsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFleetsPaginator
This is a variant of
listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListFleetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListFleetsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation.- Parameters:
listFleetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFleetsPaginator
default ListFleetsPublisher listFleetsPaginator(Consumer<ListFleetsRequest.Builder> listFleetsRequest) This is a variant of
listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListFleetsPublisher publisher = client.listFleetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListFleetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListFleetsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation.
This is a convenience which creates an instance of the
ListFleetsRequest.Builder
avoiding the need to create one manually viaListFleetsRequest.builder()
- Parameters:
listFleetsRequest
- AConsumer
that will call methods onListFleetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServerGroups
default CompletableFuture<ListGameServerGroupsResponse> listGameServerGroups(ListGameServerGroupsRequest listGameServerGroupsRequest) Lists a game server groups.
- Parameters:
listGameServerGroupsRequest
-- Returns:
- A Java Future containing the result of the ListGameServerGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServerGroups
default CompletableFuture<ListGameServerGroupsResponse> listGameServerGroups(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest) Lists a game server groups.
This is a convenience which creates an instance of the
ListGameServerGroupsRequest.Builder
avoiding the need to create one manually viaListGameServerGroupsRequest.builder()
- Parameters:
listGameServerGroupsRequest
- AConsumer
that will call methods onListGameServerGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGameServerGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServerGroupsPaginator
default ListGameServerGroupsPublisher listGameServerGroupsPaginator(ListGameServerGroupsRequest listGameServerGroupsRequest) This is a variant of
listGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsPublisher publisher = client.listGameServerGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsPublisher publisher = client.listGameServerGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation.- Parameters:
listGameServerGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServerGroupsPaginator
default ListGameServerGroupsPublisher listGameServerGroupsPaginator(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest) This is a variant of
listGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsPublisher publisher = client.listGameServerGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsPublisher publisher = client.listGameServerGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListGameServerGroupsRequest.Builder
avoiding the need to create one manually viaListGameServerGroupsRequest.builder()
- Parameters:
listGameServerGroupsRequest
- AConsumer
that will call methods onListGameServerGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServers
default CompletableFuture<ListGameServersResponse> listGameServers(ListGameServersRequest listGameServersRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
- Parameters:
listGameServersRequest
-- Returns:
- A Java Future containing the result of the ListGameServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServers
default CompletableFuture<ListGameServersResponse> listGameServers(Consumer<ListGameServersRequest.Builder> listGameServersRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.
Learn more
This is a convenience which creates an instance of the
ListGameServersRequest.Builder
avoiding the need to create one manually viaListGameServersRequest.builder()
- Parameters:
listGameServersRequest
- AConsumer
that will call methods onListGameServersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGameServers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServersPaginator
default ListGameServersPublisher listGameServersPaginator(ListGameServersRequest listGameServersRequest) This is a variant of
listGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListGameServersPublisher publisher = client.listGameServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListGameServersPublisher publisher = client.listGameServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListGameServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListGameServersResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest)
operation.- Parameters:
listGameServersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGameServersPaginator
default ListGameServersPublisher listGameServersPaginator(Consumer<ListGameServersRequest.Builder> listGameServersRequest) This is a variant of
listGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListGameServersPublisher publisher = client.listGameServersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListGameServersPublisher publisher = client.listGameServersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListGameServersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListGameServersResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest)
operation.
This is a convenience which creates an instance of the
ListGameServersRequest.Builder
avoiding the need to create one manually viaListGameServersRequest.builder()
- Parameters:
listGameServersRequest
- AConsumer
that will call methods onListGameServersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLocations
default CompletableFuture<ListLocationsResponse> listLocations(ListLocationsRequest listLocationsRequest) Lists all custom and Amazon Web Services locations.
- Parameters:
listLocationsRequest
-- Returns:
- A Java Future containing the result of the ListLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLocations
default CompletableFuture<ListLocationsResponse> listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest) Lists all custom and Amazon Web Services locations.
This is a convenience which creates an instance of the
ListLocationsRequest.Builder
avoiding the need to create one manually viaListLocationsRequest.builder()
- Parameters:
listLocationsRequest
- AConsumer
that will call methods onListLocationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLocationsPaginator
This is a variant of
listLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListLocationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListLocationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation.- Parameters:
listLocationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listLocationsPaginator
default ListLocationsPublisher listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest) This is a variant of
listLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListLocationsPublisher publisher = client.listLocationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListLocationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListLocationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation.
This is a convenience which creates an instance of the
ListLocationsRequest.Builder
avoiding the need to create one manually viaListLocationsRequest.builder()
- Parameters:
listLocationsRequest
- AConsumer
that will call methods onListLocationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScripts
Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.
Learn more
Amazon GameLift Realtime Servers
Related actions
- Parameters:
listScriptsRequest
-- Returns:
- A Java Future containing the result of the ListScripts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScripts
default CompletableFuture<ListScriptsResponse> listScripts(Consumer<ListScriptsRequest.Builder> listScriptsRequest) Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.
Learn more
Amazon GameLift Realtime Servers
Related actions
This is a convenience which creates an instance of the
ListScriptsRequest.Builder
avoiding the need to create one manually viaListScriptsRequest.builder()
- Parameters:
listScriptsRequest
- AConsumer
that will call methods onListScriptsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListScripts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScriptsPaginator
This is a variant of
listScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListScriptsPublisher publisher = client.listScriptsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListScriptsPublisher publisher = client.listScriptsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListScriptsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListScriptsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation.- Parameters:
listScriptsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listScriptsPaginator
default ListScriptsPublisher listScriptsPaginator(Consumer<ListScriptsRequest.Builder> listScriptsRequest) This is a variant of
listScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.ListScriptsPublisher publisher = client.listScriptsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.ListScriptsPublisher publisher = client.listScriptsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.ListScriptsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.ListScriptsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation.
This is a convenience which creates an instance of the
ListScriptsRequest.Builder
avoiding the need to create one manually viaListScriptsRequest.builder()
- Parameters:
listScriptsRequest
- AConsumer
that will call methods onListScriptsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.
To list tags for a resource, specify the unique ARN value for the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.
To list tags for a resource, specify the unique ARN value for the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putScalingPolicy
default CompletableFuture<PutScalingPolicyResponse> putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.
Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.
Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.
Target-based policy
A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.
For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.
To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a
TargetConfiguration
object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.Rule-based policy
A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.
For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."
A policy's rule statement has the following structure:
If
[MetricName]
is[ComparisonOperator]
[Threshold]
for[EvaluationPeriods]
minutes, then[ScalingAdjustmentType]
to/by[ScalingAdjustment]
.To implement the example, the rule statement would look like this:
If
[PercentIdleInstances]
is[GreaterThanThreshold]
[20]
for[15]
minutes, then[PercentChangeInCapacity]
to/by[10]
.To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
- Parameters:
putScalingPolicyRequest
-- Returns:
- A Java Future containing the result of the PutScalingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putScalingPolicy
default CompletableFuture<PutScalingPolicyResponse> putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.
Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.
Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.
Target-based policy
A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.
For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.
To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a
TargetConfiguration
object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.Rule-based policy
A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.
For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."
A policy's rule statement has the following structure:
If
[MetricName]
is[ComparisonOperator]
[Threshold]
for[EvaluationPeriods]
minutes, then[ScalingAdjustmentType]
to/by[ScalingAdjustment]
.To implement the example, the rule statement would look like this:
If
[PercentIdleInstances]
is[GreaterThanThreshold]
[20]
for[15]
minutes, then[PercentChangeInCapacity]
to/by[10]
.To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.
This is a convenience which creates an instance of the
PutScalingPolicyRequest.Builder
avoiding the need to create one manually viaPutScalingPolicyRequest.builder()
- Parameters:
putScalingPolicyRequest
- AConsumer
that will call methods onPutScalingPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutScalingPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerCompute
default CompletableFuture<RegisterComputeResponse> registerCompute(RegisterComputeRequest registerComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Registers a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift Anywhere fleet or a container fleet.
For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes.
To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource.
If successful, this operation returns compute details, including an Amazon GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to the Amazon GameLift server SDK action
InitSDK()
.To view compute details, call DescribeCompute with the compute name.
Learn more
-
Server SDK reference guides (for version 5.x)
- Parameters:
registerComputeRequest
-- Returns:
- A Java Future containing the result of the RegisterCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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 immediately or after a waiting period.
- NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerCompute
default CompletableFuture<RegisterComputeResponse> registerCompute(Consumer<RegisterComputeRequest.Builder> registerComputeRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Registers a compute resource in an Amazon GameLift fleet. Register computes with an Amazon GameLift Anywhere fleet or a container fleet.
For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to register fleet computes.
To register a compute, give the compute a name (must be unique within the fleet) and specify the compute resource's DNS name or IP address. Provide a fleet ID and a fleet location to associate with the compute being registered. You can optionally include the path to a TLS certificate on the compute resource.
If successful, this operation returns compute details, including an Amazon GameLift SDK endpoint or Agent endpoint. Game server processes running on the compute can use this endpoint to communicate with the Amazon GameLift service. Each server process includes the SDK endpoint in its call to the Amazon GameLift server SDK action
InitSDK()
.To view compute details, call DescribeCompute with the compute name.
Learn more
-
Server SDK reference guides (for version 5.x)
This is a convenience which creates an instance of the
RegisterComputeRequest.Builder
avoiding the need to create one manually viaRegisterComputeRequest.builder()
- Parameters:
registerComputeRequest
- AConsumer
that will call methods onRegisterComputeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterCompute operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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 immediately or after a waiting period.
- NotReadyException The operation failed because Amazon GameLift has not yet finished validating this compute. We recommend attempting 8 to 10 retries over 3 to 5 minutes with exponential backoffs and jitter.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerGameServer
default CompletableFuture<RegisterGameServerResponse> registerGameServer(RegisterGameServerRequest registerGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.
To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.
Once a game server is successfully registered, it is put in status
AVAILABLE
. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.Learn more
- Parameters:
registerGameServerRequest
-- Returns:
- A Java Future containing the result of the RegisterGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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 immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerGameServer
default CompletableFuture<RegisterGameServerResponse> registerGameServer(Consumer<RegisterGameServerRequest.Builder> registerGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.
To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.
Once a game server is successfully registered, it is put in status
AVAILABLE
. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.Learn more
This is a convenience which creates an instance of the
RegisterGameServerRequest.Builder
avoiding the need to create one manually viaRegisterGameServerRequest.builder()
- Parameters:
registerGameServerRequest
- AConsumer
that will call methods onRegisterGameServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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 immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
requestUploadCredentials
default CompletableFuture<RequestUploadCredentialsResponse> requestUploadCredentials(RequestUploadCredentialsRequest requestUploadCredentialsRequest) Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.
To request new credentials, specify the build ID as returned with an initial
CreateBuild
request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.Learn more
- Parameters:
requestUploadCredentialsRequest
-- Returns:
- A Java Future containing the result of the RequestUploadCredentials operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
requestUploadCredentials
default CompletableFuture<RequestUploadCredentialsResponse> requestUploadCredentials(Consumer<RequestUploadCredentialsRequest.Builder> requestUploadCredentialsRequest) Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.
To request new credentials, specify the build ID as returned with an initial
CreateBuild
request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.Learn more
Create a Build with Files in S3
This is a convenience which creates an instance of the
RequestUploadCredentialsRequest.Builder
avoiding the need to create one manually viaRequestUploadCredentialsRequest.builder()
- Parameters:
requestUploadCredentialsRequest
- AConsumer
that will call methods onRequestUploadCredentialsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RequestUploadCredentials operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resolveAlias
default CompletableFuture<ResolveAliasResponse> resolveAlias(ResolveAliasRequest resolveAliasRequest) Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier.
If the alias has a
SIMPLE
routing strategy, Amazon GameLift returns a fleet ID. If the alias has aTERMINAL
routing strategy, the result is aTerminalRoutingStrategyException
.Related actions
- Parameters:
resolveAliasRequest
-- Returns:
- A Java Future containing the result of the ResolveAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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. - InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resolveAlias
default CompletableFuture<ResolveAliasResponse> resolveAlias(Consumer<ResolveAliasRequest.Builder> resolveAliasRequest) Attempts to retrieve a fleet ID that is associated with an alias. Specify a unique alias identifier.
If the alias has a
SIMPLE
routing strategy, Amazon GameLift returns a fleet ID. If the alias has aTERMINAL
routing strategy, the result is aTerminalRoutingStrategyException
.Related actions
This is a convenience which creates an instance of the
ResolveAliasRequest.Builder
avoiding the need to create one manually viaResolveAliasRequest.builder()
- Parameters:
resolveAliasRequest
- AConsumer
that will call methods onResolveAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResolveAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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. - InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeGameServerGroup
default CompletableFuture<ResumeGameServerGroupResponse> resumeGameServerGroup(ResumeGameServerGroupRequest resumeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.
To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a
GameServerGroup
object is returned showing that the resumed activity is no longer listed inSuspendedActions
.Learn more
- Parameters:
resumeGameServerGroupRequest
-- Returns:
- A Java Future containing the result of the ResumeGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resumeGameServerGroup
default CompletableFuture<ResumeGameServerGroupResponse> resumeGameServerGroup(Consumer<ResumeGameServerGroupRequest.Builder> resumeGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by the SuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.
To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a
GameServerGroup
object is returned showing that the resumed activity is no longer listed inSuspendedActions
.Learn more
This is a convenience which creates an instance of the
ResumeGameServerGroupRequest.Builder
avoiding the need to create one manually viaResumeGameServerGroupRequest.builder()
- Parameters:
resumeGameServerGroupRequest
- AConsumer
that will call methods onResumeGameServerGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ResumeGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchGameSessions
default CompletableFuture<SearchGameSessionsResponse> searchGameSessions(SearchGameSessionsRequest searchGameSessionsRequest) Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
This operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue.
When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.
This operation can be used in the following ways:
-
To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.
-
To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSession
object is returned for each game session that matches the request. Search finds game sessions that are inACTIVE
status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.
-
gameSessionId -- A unique identifier for the game session. You can use either a
GameSessionId
orGameSessionArn
value. -
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
-
gameSessionProperties -- A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
. The filter expression must specify the GameProperty -- aKey
and a stringValue
to search for the game sessions.For example, to search for the above key-value pair, specify the following search filter:
gameSessionProperties.difficulty = "novice"
. All game property values are searched as strings.For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.
-
maximumSessions -- Maximum number of player sessions allowed for 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.
-
hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
Returned values for
playerSessionCount
andhasAvailablePlayerSessions
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.- Parameters:
searchGameSessionsRequest
-- Returns:
- A Java Future containing the result of the SearchGameSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
searchGameSessions
default CompletableFuture<SearchGameSessionsResponse> searchGameSessions(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest) Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
This operation is not designed to continually track game session status because that practice can cause you to exceed your API limit and generate errors. Instead, configure an Amazon Simple Notification Service (Amazon SNS) topic to receive notifications from a matchmaker or a game session placement queue.
When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.
This operation can be used in the following ways:
-
To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.
-
To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a
GameSession
object is returned for each game session that matches the request. Search finds game sessions that are inACTIVE
status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions .To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.
-
gameSessionId -- A unique identifier for the game session. You can use either a
GameSessionId
orGameSessionArn
value. -
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
-
gameSessionProperties -- A set of key-value pairs that can store custom data in a game session. For example:
{"Key": "difficulty", "Value": "novice"}
. The filter expression must specify the GameProperty -- aKey
and a stringValue
to search for the game sessions.For example, to search for the above key-value pair, specify the following search filter:
gameSessionProperties.difficulty = "novice"
. All game property values are searched as strings.For examples of searching game sessions, see the ones below, and also see Search game sessions by game property.
-
maximumSessions -- Maximum number of player sessions allowed for 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.
-
hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.
Returned values for
playerSessionCount
andhasAvailablePlayerSessions
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.
This is a convenience which creates an instance of the
SearchGameSessionsRequest.Builder
avoiding the need to create one manually viaSearchGameSessionsRequest.builder()
- Parameters:
searchGameSessionsRequest
- AConsumer
that will call methods onSearchGameSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchGameSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
searchGameSessionsPaginator
default SearchGameSessionsPublisher searchGameSessionsPaginator(SearchGameSessionsRequest searchGameSessionsRequest) This is a variant of
searchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsPublisher publisher = client.searchGameSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsPublisher publisher = client.searchGameSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.SearchGameSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest)
operation.- Parameters:
searchGameSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchGameSessionsPaginator
default SearchGameSessionsPublisher searchGameSessionsPaginator(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest) This is a variant of
searchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsPublisher publisher = client.searchGameSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsPublisher publisher = client.searchGameSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.gamelift.model.SearchGameSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest)
operation.
This is a convenience which creates an instance of the
SearchGameSessionsRequest.Builder
avoiding the need to create one manually viaSearchGameSessionsRequest.builder()
- Parameters:
searchGameSessionsRequest
- AConsumer
that will call methods onSearchGameSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- 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. - UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startFleetActions
default CompletableFuture<StartFleetActionsResponse> startFleetActions(StartFleetActionsRequest startFleetActionsRequest) Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.
This operation can be used in the following ways:
-
To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.
-
To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.
If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.
Learn more
- Parameters:
startFleetActionsRequest
-- Returns:
- A Java Future containing the result of the StartFleetActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startFleetActions
default CompletableFuture<StartFleetActionsResponse> startFleetActions(Consumer<StartFleetActionsRequest.Builder> startFleetActionsRequest) Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.
This operation can be used in the following ways:
-
To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.
-
To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.
If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect.
Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
StartFleetActionsRequest.Builder
avoiding the need to create one manually viaStartFleetActionsRequest.builder()
- Parameters:
startFleetActionsRequest
- AConsumer
that will call methods onStartFleetActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartFleetActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startGameSessionPlacement
default CompletableFuture<StartGameSessionPlacementResponse> startGameSessionPlacement(StartGameSessionPlacementRequest startGameSessionPlacementRequest) Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.
A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.
When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.
Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.
To place a new game session request, specify the following:
-
The queue name and a set of game session properties and settings
-
A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
-
(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)
-
Latency data for all players (if you want to optimize game play for the players)
If successful, a new game session placement is created.
To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is
FULFILLED
, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.- Parameters:
startGameSessionPlacementRequest
-- Returns:
- A Java Future containing the result of the StartGameSessionPlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startGameSessionPlacement
default CompletableFuture<StartGameSessionPlacementResponse> startGameSessionPlacement(Consumer<StartGameSessionPlacementRequest.Builder> startGameSessionPlacementRequest) Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.
A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.
When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.
Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.
To place a new game session request, specify the following:
-
The queue name and a set of game session properties and settings
-
A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
-
(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)
-
Latency data for all players (if you want to optimize game play for the players)
If successful, a new game session placement is created.
To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is
FULFILLED
, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.
This is a convenience which creates an instance of the
StartGameSessionPlacementRequest.Builder
avoiding the need to create one manually viaStartGameSessionPlacementRequest.builder()
- Parameters:
startGameSessionPlacementRequest
- AConsumer
that will call methods onStartGameSessionPlacementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartGameSessionPlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startMatchBackfill
default CompletableFuture<StartMatchBackfillResponse> startMatchBackfill(StartMatchBackfillRequest startMatchBackfillRequest) Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.
When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a
GameSessions
ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates theGameSession
resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.
To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the
GameSession
ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.Only game sessions created by FlexMatch are supported for match backfill.
Learn more
Backfill existing games with FlexMatch
Matchmaking events (reference)
- Parameters:
startMatchBackfillRequest
-- Returns:
- A Java Future containing the result of the StartMatchBackfill operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMatchBackfill
default CompletableFuture<StartMatchBackfillResponse> startMatchBackfill(Consumer<StartMatchBackfillRequest.Builder> startMatchBackfillRequest) Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.
When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a
GameSessions
ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates theGameSession
resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.
To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the
GameSession
ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.Only game sessions created by FlexMatch are supported for match backfill.
Learn more
Backfill existing games with FlexMatch
Matchmaking events (reference)
How Amazon GameLift FlexMatch works
This is a convenience which creates an instance of the
StartMatchBackfillRequest.Builder
avoiding the need to create one manually viaStartMatchBackfillRequest.builder()
- Parameters:
startMatchBackfillRequest
- AConsumer
that will call methods onStartMatchBackfillRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMatchBackfill operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMatchmaking
default CompletableFuture<StartMatchmakingResponse> startMatchmaking(StartMatchmakingRequest startMatchmakingRequest) Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.
To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to
QUEUED
.Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
- Parameters:
startMatchmakingRequest
-- Returns:
- A Java Future containing the result of the StartMatchmaking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startMatchmaking
default CompletableFuture<StartMatchmakingResponse> startMatchmaking(Consumer<StartMatchmakingRequest.Builder> startMatchmakingRequest) Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.
To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to
QUEUED
.Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
How Amazon GameLift FlexMatch works
This is a convenience which creates an instance of the
StartMatchmakingRequest.Builder
avoiding the need to create one manually viaStartMatchmakingRequest.builder()
- Parameters:
startMatchmakingRequest
- AConsumer
that will call methods onStartMatchmakingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartMatchmaking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopFleetActions
default CompletableFuture<StopFleetActionsResponse> stopFleetActions(StopFleetActionsRequest stopFleetActionsRequest) Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.
Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.
This operation can be used in the following ways:
-
To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.
-
To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.
If successful, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. To restart fleet actions again, call StartFleetActions.
Learn more
- Parameters:
stopFleetActionsRequest
-- Returns:
- A Java Future containing the result of the StopFleetActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
stopFleetActions
default CompletableFuture<StopFleetActionsResponse> stopFleetActions(Consumer<StopFleetActionsRequest.Builder> stopFleetActionsRequest) Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.
Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.
This operation can be used in the following ways:
-
To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.
-
To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.
If successful, Amazon GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. To restart fleet actions again, call StartFleetActions.
Learn more
Setting up Amazon GameLift Fleets
This is a convenience which creates an instance of the
StopFleetActionsRequest.Builder
avoiding the need to create one manually viaStopFleetActionsRequest.builder()
- Parameters:
stopFleetActionsRequest
- AConsumer
that will call methods onStopFleetActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopFleetActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
stopGameSessionPlacement
default CompletableFuture<StopGameSessionPlacementResponse> stopGameSessionPlacement(StopGameSessionPlacementRequest stopGameSessionPlacementRequest) Cancels a game session placement that is in
PENDING
status. To stop a placement, provide the placement ID values. If successful, the placement is moved toCANCELLED
status.- Parameters:
stopGameSessionPlacementRequest
-- Returns:
- A Java Future containing the result of the StopGameSessionPlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopGameSessionPlacement
default CompletableFuture<StopGameSessionPlacementResponse> stopGameSessionPlacement(Consumer<StopGameSessionPlacementRequest.Builder> stopGameSessionPlacementRequest) Cancels a game session placement that is in
PENDING
status. To stop a placement, provide the placement ID values. If successful, the placement is moved toCANCELLED
status.
This is a convenience which creates an instance of the
StopGameSessionPlacementRequest.Builder
avoiding the need to create one manually viaStopGameSessionPlacementRequest.builder()
- Parameters:
stopGameSessionPlacementRequest
- AConsumer
that will call methods onStopGameSessionPlacementRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopGameSessionPlacement operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopMatchmaking
default CompletableFuture<StopMatchmakingResponse> stopMatchmaking(StopMatchmakingRequest stopMatchmakingRequest) Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to
CANCELLED
.This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the
MatchmakerData
of an updated game session object, which is provided to the game server.If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).
Learn more
- Parameters:
stopMatchmakingRequest
-- Returns:
- A Java Future containing the result of the StopMatchmaking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopMatchmaking
default CompletableFuture<StopMatchmakingResponse> stopMatchmaking(Consumer<StopMatchmakingRequest.Builder> stopMatchmakingRequest) Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to
CANCELLED
.This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the
MatchmakerData
of an updated game session object, which is provided to the game server.If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).
Learn more
Add FlexMatch to a game client
This is a convenience which creates an instance of the
StopMatchmakingRequest.Builder
avoiding the need to create one manually viaStopMatchmakingRequest.builder()
- Parameters:
stopMatchmakingRequest
- AConsumer
that will call methods onStopMatchmakingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopMatchmaking operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
suspendGameServerGroup
default CompletableFuture<SuspendGameServerGroupResponse> suspendGameServerGroup(SuspendGameServerGroupRequest suspendGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
-
Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a
GameServerGroup
object is returned showing that the activity is listed inSuspendedActions
.Learn more
- Parameters:
suspendGameServerGroupRequest
-- Returns:
- A Java Future containing the result of the SuspendGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
suspendGameServerGroup
default CompletableFuture<SuspendGameServerGroupResponse> suspendGameServerGroup(Consumer<SuspendGameServerGroupRequest.Builder> suspendGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:
-
Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.
To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a
GameServerGroup
object is returned showing that the activity is listed inSuspendedActions
.Learn more
This is a convenience which creates an instance of the
SuspendGameServerGroupRequest.Builder
avoiding the need to create one manually viaSuspendGameServerGroupRequest.builder()
- Parameters:
suspendGameServerGroupRequest
- AConsumer
that will call methods onSuspendGameServerGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SuspendGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.
To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, and more. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.
To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.
To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to remove. This operation succeeds even if the list includes tags that aren't assigned to the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for Amazon GameLift resources that support tagging.
To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to remove. This operation succeeds even if the list includes tags that aren't assigned to the resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- TaggingFailedException The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAlias
Updates properties for an alias. Specify the unique identifier of the alias to be updated and the new property values. When reassigning an alias to a new fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
- Parameters:
updateAliasRequest
-- Returns:
- A Java Future containing the result of the UpdateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAlias
default CompletableFuture<UpdateAliasResponse> updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest) Updates properties for an alias. Specify the unique identifier of the alias to be updated and the new property values. When reassigning an alias to a new fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
This is a convenience which creates an instance of the
UpdateAliasRequest.Builder
avoiding the need to create one manually viaUpdateAliasRequest.builder()
- Parameters:
updateAliasRequest
- AConsumer
that will call methods onUpdateAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBuild
Updates metadata in a build resource, 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.
Learn more
- Parameters:
updateBuildRequest
-- Returns:
- A Java Future containing the result of the UpdateBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBuild
default CompletableFuture<UpdateBuildResponse> updateBuild(Consumer<UpdateBuildRequest.Builder> updateBuildRequest) Updates metadata in a build resource, 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.
Learn more
This is a convenience which creates an instance of the
UpdateBuildRequest.Builder
avoiding the need to create one manually viaUpdateBuildRequest.builder()
- Parameters:
updateBuildRequest
- AConsumer
that will call methods onUpdateBuildRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateBuild operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFleetAttributes
default CompletableFuture<UpdateFleetAttributesResponse> updateFleetAttributes(UpdateFleetAttributesRequest updateFleetAttributesRequest) Updates a fleet's mutable attributes, such as game session protection and resource creation limits.
To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift returns the identifiers for the updated fleet.
Learn more
- Parameters:
updateFleetAttributesRequest
-- Returns:
- A Java Future containing the result of the UpdateFleetAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- 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 immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFleetAttributes
default CompletableFuture<UpdateFleetAttributesResponse> updateFleetAttributes(Consumer<UpdateFleetAttributesRequest.Builder> updateFleetAttributesRequest) Updates a fleet's mutable attributes, such as game session protection and resource creation limits.
To update fleet attributes, specify the fleet ID and the property values that you want to change. If successful, Amazon GameLift returns the identifiers for the updated fleet.
Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
UpdateFleetAttributesRequest.Builder
avoiding the need to create one manually viaUpdateFleetAttributesRequest.builder()
- Parameters:
updateFleetAttributesRequest
- AConsumer
that will call methods onUpdateFleetAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFleetAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- 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 immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFleetCapacity
default CompletableFuture<UpdateFleetCapacityResponse> updateFleetCapacity(UpdateFleetCapacityRequest updateFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually.
Use this operation to set these fleet capacity properties:
-
Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range.
-
Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.
To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the
Location
parameter. The fleet must be inACTIVE
status.To update capacity for a fleet's remote location, set the
Location
parameter to the location to update. The location must be inACTIVE
status.If successful, Amazon GameLift updates the capacity settings and returns the identifiers for the updated fleet and/or location. If a requested change to desired capacity exceeds the instance type's limit, the
LimitExceeded
exception occurs.Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.
Learn more
- Parameters:
updateFleetCapacityRequest
-- Returns:
- A Java Future containing the result of the UpdateFleetCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- 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 immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateFleetCapacity
default CompletableFuture<UpdateFleetCapacityResponse> updateFleetCapacity(Consumer<UpdateFleetCapacityRequest.Builder> updateFleetCapacityRequest) This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Updates capacity settings for a managed EC2 fleet or container fleet. For these fleets, you adjust capacity by changing the number of instances in the fleet. Fleet capacity determines the number of game sessions and players that the fleet can host based on its configuration. For fleets with multiple locations, use this operation to manage capacity settings in each location individually.
Use this operation to set these fleet capacity properties:
-
Minimum/maximum size: Set hard limits on the number of Amazon EC2 instances allowed. If Amazon GameLift receives a request--either through manual update or automatic scaling--it won't change the capacity to a value outside of this range.
-
Desired capacity: As an alternative to automatic scaling, manually set the number of Amazon EC2 instances to be maintained. Before changing a fleet's desired capacity, check the maximum capacity of the fleet's Amazon EC2 instance type by calling DescribeEC2InstanceLimits.
To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the
Location
parameter. The fleet must be inACTIVE
status.To update capacity for a fleet's remote location, set the
Location
parameter to the location to update. The location must be inACTIVE
status.If successful, Amazon GameLift updates the capacity settings and returns the identifiers for the updated fleet and/or location. If a requested change to desired capacity exceeds the instance type's limit, the
LimitExceeded
exception occurs.Updates often prompt an immediate change in fleet capacity, such as when current capacity is different than the new desired capacity or outside the new limits. In this scenario, Amazon GameLift automatically initiates steps to add or remove instances in the fleet location. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity.
Learn more
This is a convenience which creates an instance of the
UpdateFleetCapacityRequest.Builder
avoiding the need to create one manually viaUpdateFleetCapacityRequest.builder()
- Parameters:
updateFleetCapacityRequest
- AConsumer
that will call methods onUpdateFleetCapacityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFleetCapacity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- 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 immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateFleetPortSettings
default CompletableFuture<UpdateFleetPortSettingsResponse> updateFleetPortSettings(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest) Updates permissions that allow inbound traffic to connect to game sessions in the fleet.
To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in
InboundPermissionAuthorizations
, and permissions you want to remove inInboundPermissionRevocations
. Permissions to be removed must match existing fleet permissions.For a container fleet, inbound permissions must specify port numbers that are defined in the fleet's connection port settings.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling
DescribeFleetPortSettings
with a location name.Learn more
- Parameters:
updateFleetPortSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateFleetPortSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- 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 immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateFleetPortSettings
default CompletableFuture<UpdateFleetPortSettingsResponse> updateFleetPortSettings(Consumer<UpdateFleetPortSettingsRequest.Builder> updateFleetPortSettingsRequest) Updates permissions that allow inbound traffic to connect to game sessions in the fleet.
To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in
InboundPermissionAuthorizations
, and permissions you want to remove inInboundPermissionRevocations
. Permissions to be removed must match existing fleet permissions.For a container fleet, inbound permissions must specify port numbers that are defined in the fleet's connection port settings.
If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling
DescribeFleetPortSettings
with a location name.Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
UpdateFleetPortSettingsRequest.Builder
avoiding the need to create one manually viaUpdateFleetPortSettingsRequest.builder()
- Parameters:
updateFleetPortSettingsRequest
- AConsumer
that will call methods onUpdateFleetPortSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFleetPortSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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.
- 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 immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGameServer
default CompletableFuture<UpdateGameServerResponse> updateGameServer(UpdateGameServerRequest updateGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
-
To update the game server's utilization status from
AVAILABLE
(when the game server is available to be claimed) toUTILIZED
(when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from toUTILIZED
toAVAILABLE
. -
To report health status, identify the game server and game server group and set health check to
HEALTHY
. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. -
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
- Parameters:
updateGameServerRequest
-- Returns:
- A Java Future containing the result of the UpdateGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateGameServer
default CompletableFuture<UpdateGameServerResponse> updateGameServer(Consumer<UpdateGameServerRequest.Builder> updateGameServerRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help Amazon GameLift FleetIQ track game server availability. This operation is called by a game server process that is running on an instance in a game server group.
Use this operation to update the following types of game server information. You can make all three types of updates in the same request:
-
To update the game server's utilization status from
AVAILABLE
(when the game server is available to be claimed) toUTILIZED
(when the game server is currently hosting games). Identify the game server and game server group and specify the new utilization status. You can't change the status from toUTILIZED
toAVAILABLE
. -
To report health status, identify the game server and game server group and set health check to
HEALTHY
. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds. -
To change game server metadata, provide updated game server data.
Once a game server is successfully updated, the relevant statuses and timestamps are updated.
Learn more
This is a convenience which creates an instance of the
UpdateGameServerRequest.Builder
avoiding the need to create one manually viaUpdateGameServerRequest.builder()
- Parameters:
updateGameServerRequest
- AConsumer
that will call methods onUpdateGameServerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGameServer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateGameServerGroup
default CompletableFuture<UpdateGameServerGroupResponse> updateGameServerGroup(UpdateGameServerGroupRequest updateGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.
To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
GameServerGroup
object is returned.Learn more
- Parameters:
updateGameServerGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGameServerGroup
default CompletableFuture<UpdateGameServerGroupResponse> updateGameServerGroup(Consumer<UpdateGameServerGroupRequest.Builder> updateGameServerGroupRequest) This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Updates Amazon GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.
To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
GameServerGroup
object is returned.Learn more
This is a convenience which creates an instance of the
UpdateGameServerGroupRequest.Builder
avoiding the need to create one manually viaUpdateGameServerGroupRequest.builder()
- Parameters:
updateGameServerGroupRequest
- AConsumer
that will call methods onUpdateGameServerGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGameServerGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGameSession
default CompletableFuture<UpdateGameSessionResponse> updateGameSession(UpdateGameSessionRequest updateGameSessionRequest) Updates the mutable properties of a game session.
To update a game session, specify the game session ID and the values you want to change.
If successful, the updated
GameSession
object is returned.- Parameters:
updateGameSessionRequest
-- Returns:
- A Java Future containing the result of the UpdateGameSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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 immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGameSession
default CompletableFuture<UpdateGameSessionResponse> updateGameSession(Consumer<UpdateGameSessionRequest.Builder> updateGameSessionRequest) Updates the mutable properties of a game session.
To update a game session, specify the game session ID and the values you want to change.
If successful, the updated
GameSession
object is returned.
This is a convenience which creates an instance of the
UpdateGameSessionRequest.Builder
avoiding the need to create one manually viaUpdateGameSessionRequest.builder()
- Parameters:
updateGameSessionRequest
- AConsumer
that will call methods onUpdateGameSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGameSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- 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 immediately or after a waiting period.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidGameSessionStatusException The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGameSessionQueue
default CompletableFuture<UpdateGameSessionQueueResponse> updateGameSessionQueue(UpdateGameSessionQueueRequest updateGameSessionQueueRequest) Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
Learn more
- Parameters:
updateGameSessionQueueRequest
-- Returns:
- A Java Future containing the result of the UpdateGameSessionQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGameSessionQueue
default CompletableFuture<UpdateGameSessionQueueResponse> updateGameSessionQueue(Consumer<UpdateGameSessionQueueRequest.Builder> updateGameSessionQueueRequest) Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.
Learn more
This is a convenience which creates an instance of the
UpdateGameSessionQueueRequest.Builder
avoiding the need to create one manually viaUpdateGameSessionQueueRequest.builder()
- Parameters:
updateGameSessionQueueRequest
- AConsumer
that will call methods onUpdateGameSessionQueueRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGameSessionQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMatchmakingConfiguration
default CompletableFuture<UpdateMatchmakingConfigurationResponse> updateMatchmakingConfiguration(UpdateMatchmakingConfigurationRequest updateMatchmakingConfigurationRequest) Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.
Learn more
- Parameters:
updateMatchmakingConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateMatchmakingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMatchmakingConfiguration
default CompletableFuture<UpdateMatchmakingConfigurationResponse> updateMatchmakingConfiguration(Consumer<UpdateMatchmakingConfigurationRequest.Builder> updateMatchmakingConfigurationRequest) Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.
Learn more
This is a convenience which creates an instance of the
UpdateMatchmakingConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateMatchmakingConfigurationRequest.builder()
- Parameters:
updateMatchmakingConfigurationRequest
- AConsumer
that will call methods onUpdateMatchmakingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMatchmakingConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRuntimeConfiguration
default CompletableFuture<UpdateRuntimeConfigurationResponse> updateRuntimeConfiguration(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest) Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2 fleets, it determines what server processes to run on each fleet instance. For container fleets, it describes what server processes to run in each replica container group. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in
ACTIVE
status.To update runtime configuration, specify the fleet ID and provide a
RuntimeConfiguration
with an updated set of server process configurations.If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
- Parameters:
updateRuntimeConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateRuntimeConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRuntimeConfiguration
default CompletableFuture<UpdateRuntimeConfigurationResponse> updateRuntimeConfiguration(Consumer<UpdateRuntimeConfigurationRequest.Builder> updateRuntimeConfigurationRequest) Updates the runtime configuration for the specified fleet. The runtime configuration tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2 fleets, it determines what server processes to run on each fleet instance. For container fleets, it describes what server processes to run in each replica container group. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in
ACTIVE
status.To update runtime configuration, specify the fleet ID and provide a
RuntimeConfiguration
with an updated set of server process configurations.If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
Setting up Amazon GameLift fleets
This is a convenience which creates an instance of the
UpdateRuntimeConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateRuntimeConfigurationRequest.builder()
- Parameters:
updateRuntimeConfigurationRequest
- AConsumer
that will call methods onUpdateRuntimeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRuntimeConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values 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.
- LimitExceededException The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateScript
default CompletableFuture<UpdateScriptResponse> updateScript(UpdateScriptRequest updateScriptRequest) Updates Realtime script metadata and content.
To update script metadata, specify the script ID and provide updated name and/or version values.
To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.
If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
- Parameters:
updateScriptRequest
-- Returns:
- A Java Future containing the result of the UpdateScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateScript
default CompletableFuture<UpdateScriptResponse> updateScript(Consumer<UpdateScriptRequest.Builder> updateScriptRequest) Updates Realtime script metadata and content.
To update script metadata, specify the script ID and provide updated name and/or version values.
To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.
If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.
Learn more
Amazon GameLift Realtime Servers
Related actions
This is a convenience which creates an instance of the
UpdateScriptRequest.Builder
avoiding the need to create one manually viaUpdateScriptRequest.builder()
- Parameters:
updateScriptRequest
- AConsumer
that will call methods onUpdateScriptRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateScript operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The client failed authentication. Clients should not retry such requests.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- NotFoundException THe requested resources was not found. The resource was either not created yet or deleted.
- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validateMatchmakingRuleSet
default CompletableFuture<ValidateMatchmakingRuleSetResponse> validateMatchmakingRuleSet(ValidateMatchmakingRuleSetRequest validateMatchmakingRuleSetRequest) Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.
Learn more
- Parameters:
validateMatchmakingRuleSetRequest
-- Returns:
- A Java Future containing the result of the ValidateMatchmakingRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
validateMatchmakingRuleSet
default CompletableFuture<ValidateMatchmakingRuleSetResponse> validateMatchmakingRuleSet(Consumer<ValidateMatchmakingRuleSetRequest.Builder> validateMatchmakingRuleSetRequest) Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.
Learn more
This is a convenience which creates an instance of the
ValidateMatchmakingRuleSetRequest.Builder
avoiding the need to create one manually viaValidateMatchmakingRuleSetRequest.builder()
- Parameters:
validateMatchmakingRuleSetRequest
- AConsumer
that will call methods onValidateMatchmakingRuleSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidateMatchmakingRuleSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
- UnsupportedRegionException The requested operation is not supported in the Region specified.
- InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GameLiftException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aGameLiftAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aGameLiftAsyncClient
.
-