@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface GameLiftClient extends SdkClient
builder() method.
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 GameLift solutions
Get more information on these GameLift solutions in the GameLift Developer Guide.
GameLift managed hosting -- 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 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 GameLift infrastructure already built in. Then use the full range of GameLift managed hosting features, including FlexMatch, for your game.
GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.
GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with 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:
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcceptMatchResponse |
acceptMatch(AcceptMatchRequest acceptMatchRequest)
Registers a player's acceptance or rejection of a proposed FlexMatch match.
|
default AcceptMatchResponse |
acceptMatch(Consumer<AcceptMatchRequest.Builder> acceptMatchRequest)
Registers a player's acceptance or rejection of a proposed FlexMatch match.
|
static GameLiftClientBuilder |
builder()
Create a builder that can be used to configure and create a
GameLiftClient. |
default ClaimGameServerResponse |
claimGameServer(ClaimGameServerRequest claimGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default ClaimGameServerResponse |
claimGameServer(Consumer<ClaimGameServerRequest.Builder> claimGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
static GameLiftClient |
create()
Create a
GameLiftClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAliasResponse |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates an alias for a fleet.
|
default CreateAliasResponse |
createAlias(CreateAliasRequest createAliasRequest)
Creates an alias for a fleet.
|
default CreateBuildResponse |
createBuild(Consumer<CreateBuildRequest.Builder> createBuildRequest)
Creates a new Amazon GameLift build resource for your game server binary files.
|
default CreateBuildResponse |
createBuild(CreateBuildRequest createBuildRequest)
Creates a new Amazon GameLift build resource for your game server binary files.
|
default CreateFleetResponse |
createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest)
Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game
server or Realtime Servers.
|
default CreateFleetResponse |
createFleet(CreateFleetRequest createFleetRequest)
Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game
server or Realtime Servers.
|
default CreateFleetLocationsResponse |
createFleetLocations(Consumer<CreateFleetLocationsRequest.Builder> createFleetLocationsRequest)
Adds remote locations to a fleet and begins populating the new locations with EC2 instances.
|
default CreateFleetLocationsResponse |
createFleetLocations(CreateFleetLocationsRequest createFleetLocationsRequest)
Adds remote locations to a fleet and begins populating the new locations with EC2 instances.
|
default CreateGameServerGroupResponse |
createGameServerGroup(Consumer<CreateGameServerGroupRequest.Builder> createGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default CreateGameServerGroupResponse |
createGameServerGroup(CreateGameServerGroupRequest createGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default CreateGameSessionResponse |
createGameSession(Consumer<CreateGameSessionRequest.Builder> createGameSessionRequest)
Creates a multiplayer game session for players in a specific fleet location.
|
default CreateGameSessionResponse |
createGameSession(CreateGameSessionRequest createGameSessionRequest)
Creates a multiplayer game session for players in a specific fleet location.
|
default CreateGameSessionQueueResponse |
createGameSessionQueue(Consumer<CreateGameSessionQueueRequest.Builder> createGameSessionQueueRequest)
Creates a placement queue that processes requests for new game sessions.
|
default CreateGameSessionQueueResponse |
createGameSessionQueue(CreateGameSessionQueueRequest createGameSessionQueueRequest)
Creates a placement queue that processes requests for new game sessions.
|
default CreateLocationResponse |
createLocation(Consumer<CreateLocationRequest.Builder> createLocationRequest)
Creates a custom location for use in an Anywhere fleet.
|
default CreateLocationResponse |
createLocation(CreateLocationRequest createLocationRequest)
Creates a custom location for use in an Anywhere fleet.
|
default CreateMatchmakingConfigurationResponse |
createMatchmakingConfiguration(Consumer<CreateMatchmakingConfigurationRequest.Builder> createMatchmakingConfigurationRequest)
Defines a new matchmaking configuration for use with FlexMatch.
|
default CreateMatchmakingConfigurationResponse |
createMatchmakingConfiguration(CreateMatchmakingConfigurationRequest createMatchmakingConfigurationRequest)
Defines a new matchmaking configuration for use with FlexMatch.
|
default CreateMatchmakingRuleSetResponse |
createMatchmakingRuleSet(Consumer<CreateMatchmakingRuleSetRequest.Builder> createMatchmakingRuleSetRequest)
Creates a new rule set for FlexMatch matchmaking.
|
default CreateMatchmakingRuleSetResponse |
createMatchmakingRuleSet(CreateMatchmakingRuleSetRequest createMatchmakingRuleSetRequest)
Creates a new rule set for FlexMatch matchmaking.
|
default CreatePlayerSessionResponse |
createPlayerSession(Consumer<CreatePlayerSessionRequest.Builder> createPlayerSessionRequest)
Reserves an open player slot in a game session for a player.
|
default CreatePlayerSessionResponse |
createPlayerSession(CreatePlayerSessionRequest createPlayerSessionRequest)
Reserves an open player slot in a game session for a player.
|
default CreatePlayerSessionsResponse |
createPlayerSessions(Consumer<CreatePlayerSessionsRequest.Builder> createPlayerSessionsRequest)
Reserves open slots in a game session for a group of players.
|
default CreatePlayerSessionsResponse |
createPlayerSessions(CreatePlayerSessionsRequest createPlayerSessionsRequest)
Reserves open slots in a game session for a group of players.
|
default CreateScriptResponse |
createScript(Consumer<CreateScriptRequest.Builder> createScriptRequest)
Creates a new script record for your Realtime Servers script.
|
default CreateScriptResponse |
createScript(CreateScriptRequest createScriptRequest)
Creates a new script record for your Realtime Servers script.
|
default 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.
|
default 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.
|
default 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.
|
default 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.
|
default DeleteAliasResponse |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Deletes an alias.
|
default DeleteAliasResponse |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes an alias.
|
default DeleteBuildResponse |
deleteBuild(Consumer<DeleteBuildRequest.Builder> deleteBuildRequest)
Deletes a build.
|
default DeleteBuildResponse |
deleteBuild(DeleteBuildRequest deleteBuildRequest)
Deletes a build.
|
default DeleteFleetResponse |
deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest)
Deletes all resources and information related a fleet.
|
default DeleteFleetResponse |
deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes all resources and information related a fleet.
|
default DeleteFleetLocationsResponse |
deleteFleetLocations(Consumer<DeleteFleetLocationsRequest.Builder> deleteFleetLocationsRequest)
Removes locations from a multi-location fleet.
|
default DeleteFleetLocationsResponse |
deleteFleetLocations(DeleteFleetLocationsRequest deleteFleetLocationsRequest)
Removes locations from a multi-location fleet.
|
default DeleteGameServerGroupResponse |
deleteGameServerGroup(Consumer<DeleteGameServerGroupRequest.Builder> deleteGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DeleteGameServerGroupResponse |
deleteGameServerGroup(DeleteGameServerGroupRequest deleteGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DeleteGameSessionQueueResponse |
deleteGameSessionQueue(Consumer<DeleteGameSessionQueueRequest.Builder> deleteGameSessionQueueRequest)
Deletes a game session queue.
|
default DeleteGameSessionQueueResponse |
deleteGameSessionQueue(DeleteGameSessionQueueRequest deleteGameSessionQueueRequest)
Deletes a game session queue.
|
default DeleteLocationResponse |
deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
Deletes a custom location.
|
default DeleteLocationResponse |
deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes a custom location.
|
default DeleteMatchmakingConfigurationResponse |
deleteMatchmakingConfiguration(Consumer<DeleteMatchmakingConfigurationRequest.Builder> deleteMatchmakingConfigurationRequest)
Permanently removes a FlexMatch matchmaking configuration.
|
default DeleteMatchmakingConfigurationResponse |
deleteMatchmakingConfiguration(DeleteMatchmakingConfigurationRequest deleteMatchmakingConfigurationRequest)
Permanently removes a FlexMatch matchmaking configuration.
|
default DeleteMatchmakingRuleSetResponse |
deleteMatchmakingRuleSet(Consumer<DeleteMatchmakingRuleSetRequest.Builder> deleteMatchmakingRuleSetRequest)
Deletes an existing matchmaking rule set.
|
default DeleteMatchmakingRuleSetResponse |
deleteMatchmakingRuleSet(DeleteMatchmakingRuleSetRequest deleteMatchmakingRuleSetRequest)
Deletes an existing matchmaking rule set.
|
default DeleteScalingPolicyResponse |
deleteScalingPolicy(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest)
Deletes a fleet scaling policy.
|
default DeleteScalingPolicyResponse |
deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest)
Deletes a fleet scaling policy.
|
default DeleteScriptResponse |
deleteScript(Consumer<DeleteScriptRequest.Builder> deleteScriptRequest)
Deletes a Realtime script.
|
default DeleteScriptResponse |
deleteScript(DeleteScriptRequest deleteScriptRequest)
Deletes a Realtime script.
|
default DeleteVpcPeeringAuthorizationResponse |
deleteVpcPeeringAuthorization(Consumer<DeleteVpcPeeringAuthorizationRequest.Builder> deleteVpcPeeringAuthorizationRequest)
Cancels a pending VPC peering authorization for the specified VPC.
|
default DeleteVpcPeeringAuthorizationResponse |
deleteVpcPeeringAuthorization(DeleteVpcPeeringAuthorizationRequest deleteVpcPeeringAuthorizationRequest)
Cancels a pending VPC peering authorization for the specified VPC.
|
default DeleteVpcPeeringConnectionResponse |
deleteVpcPeeringConnection(Consumer<DeleteVpcPeeringConnectionRequest.Builder> deleteVpcPeeringConnectionRequest)
Removes a VPC peering connection.
|
default DeleteVpcPeeringConnectionResponse |
deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest)
Removes a VPC peering connection.
|
default DeregisterComputeResponse |
deregisterCompute(Consumer<DeregisterComputeRequest.Builder> deregisterComputeRequest)
Removes a compute resource from the specified fleet.
|
default DeregisterComputeResponse |
deregisterCompute(DeregisterComputeRequest deregisterComputeRequest)
Removes a compute resource from the specified fleet.
|
default DeregisterGameServerResponse |
deregisterGameServer(Consumer<DeregisterGameServerRequest.Builder> deregisterGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DeregisterGameServerResponse |
deregisterGameServer(DeregisterGameServerRequest deregisterGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeAliasResponse |
describeAlias(Consumer<DescribeAliasRequest.Builder> describeAliasRequest)
Retrieves properties for an alias.
|
default DescribeAliasResponse |
describeAlias(DescribeAliasRequest describeAliasRequest)
Retrieves properties for an alias.
|
default DescribeBuildResponse |
describeBuild(Consumer<DescribeBuildRequest.Builder> describeBuildRequest)
Retrieves properties for a custom game build.
|
default DescribeBuildResponse |
describeBuild(DescribeBuildRequest describeBuildRequest)
Retrieves properties for a custom game build.
|
default DescribeComputeResponse |
describeCompute(Consumer<DescribeComputeRequest.Builder> describeComputeRequest)
Retrieves properties for a compute resource.
|
default DescribeComputeResponse |
describeCompute(DescribeComputeRequest describeComputeRequest)
Retrieves properties for a compute resource.
|
default DescribeEc2InstanceLimitsResponse |
describeEC2InstanceLimits()
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.
|
default DescribeEc2InstanceLimitsResponse |
describeEC2InstanceLimits(Consumer<DescribeEc2InstanceLimitsRequest.Builder> describeEc2InstanceLimitsRequest)
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.
|
default DescribeEc2InstanceLimitsResponse |
describeEC2InstanceLimits(DescribeEc2InstanceLimitsRequest describeEc2InstanceLimitsRequest)
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.
|
default DescribeFleetAttributesResponse |
describeFleetAttributes()
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all
instances in the fleet.
|
default DescribeFleetAttributesResponse |
describeFleetAttributes(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest)
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all
instances in the fleet.
|
default DescribeFleetAttributesResponse |
describeFleetAttributes(DescribeFleetAttributesRequest describeFleetAttributesRequest)
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all
instances in the fleet.
|
default DescribeFleetAttributesIterable |
describeFleetAttributesPaginator()
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all
instances in the fleet.
|
default DescribeFleetAttributesIterable |
describeFleetAttributesPaginator(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest)
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all
instances in the fleet.
|
default DescribeFleetAttributesIterable |
describeFleetAttributesPaginator(DescribeFleetAttributesRequest describeFleetAttributesRequest)
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all
instances in the fleet.
|
default DescribeFleetCapacityResponse |
describeFleetCapacity()
Retrieves the resource capacity settings for one or more fleets.
|
default DescribeFleetCapacityResponse |
describeFleetCapacity(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest)
Retrieves the resource capacity settings for one or more fleets.
|
default DescribeFleetCapacityResponse |
describeFleetCapacity(DescribeFleetCapacityRequest describeFleetCapacityRequest)
Retrieves the resource capacity settings for one or more fleets.
|
default DescribeFleetCapacityIterable |
describeFleetCapacityPaginator()
Retrieves the resource capacity settings for one or more fleets.
|
default DescribeFleetCapacityIterable |
describeFleetCapacityPaginator(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest)
Retrieves the resource capacity settings for one or more fleets.
|
default DescribeFleetCapacityIterable |
describeFleetCapacityPaginator(DescribeFleetCapacityRequest describeFleetCapacityRequest)
Retrieves the resource capacity settings for one or more fleets.
|
default DescribeFleetEventsResponse |
describeFleetEvents(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest)
Retrieves entries from a fleet's event log.
|
default DescribeFleetEventsResponse |
describeFleetEvents(DescribeFleetEventsRequest describeFleetEventsRequest)
Retrieves entries from a fleet's event log.
|
default DescribeFleetEventsIterable |
describeFleetEventsPaginator(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest)
Retrieves entries from a fleet's event log.
|
default DescribeFleetEventsIterable |
describeFleetEventsPaginator(DescribeFleetEventsRequest describeFleetEventsRequest)
Retrieves entries from a fleet's event log.
|
default DescribeFleetLocationAttributesResponse |
describeFleetLocationAttributes(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest)
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet
activity.
|
default DescribeFleetLocationAttributesResponse |
describeFleetLocationAttributes(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest)
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet
activity.
|
default DescribeFleetLocationAttributesIterable |
describeFleetLocationAttributesPaginator(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest)
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet
activity.
|
default DescribeFleetLocationAttributesIterable |
describeFleetLocationAttributesPaginator(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest)
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet
activity.
|
default DescribeFleetLocationCapacityResponse |
describeFleetLocationCapacity(Consumer<DescribeFleetLocationCapacityRequest.Builder> describeFleetLocationCapacityRequest)
Retrieves the resource capacity settings for a fleet location.
|
default DescribeFleetLocationCapacityResponse |
describeFleetLocationCapacity(DescribeFleetLocationCapacityRequest describeFleetLocationCapacityRequest)
Retrieves the resource capacity settings for a fleet location.
|
default DescribeFleetLocationUtilizationResponse |
describeFleetLocationUtilization(Consumer<DescribeFleetLocationUtilizationRequest.Builder> describeFleetLocationUtilizationRequest)
Retrieves current usage data for a fleet location.
|
default DescribeFleetLocationUtilizationResponse |
describeFleetLocationUtilization(DescribeFleetLocationUtilizationRequest describeFleetLocationUtilizationRequest)
Retrieves current usage data for a fleet location.
|
default DescribeFleetPortSettingsResponse |
describeFleetPortSettings(Consumer<DescribeFleetPortSettingsRequest.Builder> describeFleetPortSettingsRequest)
Retrieves a fleet's inbound connection permissions.
|
default DescribeFleetPortSettingsResponse |
describeFleetPortSettings(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest)
Retrieves a fleet's inbound connection permissions.
|
default DescribeFleetUtilizationResponse |
describeFleetUtilization()
Retrieves utilization statistics for one or more fleets.
|
default DescribeFleetUtilizationResponse |
describeFleetUtilization(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest)
Retrieves utilization statistics for one or more fleets.
|
default DescribeFleetUtilizationResponse |
describeFleetUtilization(DescribeFleetUtilizationRequest describeFleetUtilizationRequest)
Retrieves utilization statistics for one or more fleets.
|
default DescribeFleetUtilizationIterable |
describeFleetUtilizationPaginator()
Retrieves utilization statistics for one or more fleets.
|
default DescribeFleetUtilizationIterable |
describeFleetUtilizationPaginator(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest)
Retrieves utilization statistics for one or more fleets.
|
default DescribeFleetUtilizationIterable |
describeFleetUtilizationPaginator(DescribeFleetUtilizationRequest describeFleetUtilizationRequest)
Retrieves utilization statistics for one or more fleets.
|
default DescribeGameServerResponse |
describeGameServer(Consumer<DescribeGameServerRequest.Builder> describeGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerResponse |
describeGameServer(DescribeGameServerRequest describeGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerGroupResponse |
describeGameServerGroup(Consumer<DescribeGameServerGroupRequest.Builder> describeGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerGroupResponse |
describeGameServerGroup(DescribeGameServerGroupRequest describeGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerInstancesResponse |
describeGameServerInstances(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerInstancesResponse |
describeGameServerInstances(DescribeGameServerInstancesRequest describeGameServerInstancesRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerInstancesIterable |
describeGameServerInstancesPaginator(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default DescribeGameServerInstancesIterable |
describeGameServerInstancesPaginator(DescribeGameServerInstancesRequest describeGameServerInstancesRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default 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.
|
default 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.
|
default DescribeGameSessionDetailsIterable |
describeGameSessionDetailsPaginator(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.
|
default DescribeGameSessionDetailsIterable |
describeGameSessionDetailsPaginator(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.
|
default DescribeGameSessionPlacementResponse |
describeGameSessionPlacement(Consumer<DescribeGameSessionPlacementRequest.Builder> describeGameSessionPlacementRequest)
Retrieves information, including current status, about a game session placement request.
|
default DescribeGameSessionPlacementResponse |
describeGameSessionPlacement(DescribeGameSessionPlacementRequest describeGameSessionPlacementRequest)
Retrieves information, including current status, about a game session placement request.
|
default DescribeGameSessionQueuesResponse |
describeGameSessionQueues()
Retrieves the properties for one or more game session queues.
|
default DescribeGameSessionQueuesResponse |
describeGameSessionQueues(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest)
Retrieves the properties for one or more game session queues.
|
default DescribeGameSessionQueuesResponse |
describeGameSessionQueues(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest)
Retrieves the properties for one or more game session queues.
|
default DescribeGameSessionQueuesIterable |
describeGameSessionQueuesPaginator()
Retrieves the properties for one or more game session queues.
|
default DescribeGameSessionQueuesIterable |
describeGameSessionQueuesPaginator(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest)
Retrieves the properties for one or more game session queues.
|
default DescribeGameSessionQueuesIterable |
describeGameSessionQueuesPaginator(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest)
Retrieves the properties for one or more game session queues.
|
default DescribeGameSessionsResponse |
describeGameSessions(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest)
Retrieves a set of one or more game sessions in a specific fleet location.
|
default DescribeGameSessionsResponse |
describeGameSessions(DescribeGameSessionsRequest describeGameSessionsRequest)
Retrieves a set of one or more game sessions in a specific fleet location.
|
default DescribeGameSessionsIterable |
describeGameSessionsPaginator(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest)
Retrieves a set of one or more game sessions in a specific fleet location.
|
default DescribeGameSessionsIterable |
describeGameSessionsPaginator(DescribeGameSessionsRequest describeGameSessionsRequest)
Retrieves a set of one or more game sessions in a specific fleet location.
|
default DescribeInstancesResponse |
describeInstances(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
|
default DescribeInstancesResponse |
describeInstances(DescribeInstancesRequest describeInstancesRequest)
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
|
default DescribeInstancesIterable |
describeInstancesPaginator(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest)
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
|
default DescribeInstancesIterable |
describeInstancesPaginator(DescribeInstancesRequest describeInstancesRequest)
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
|
default DescribeMatchmakingResponse |
describeMatchmaking(Consumer<DescribeMatchmakingRequest.Builder> describeMatchmakingRequest)
Retrieves one or more matchmaking tickets.
|
default DescribeMatchmakingResponse |
describeMatchmaking(DescribeMatchmakingRequest describeMatchmakingRequest)
Retrieves one or more matchmaking tickets.
|
default DescribeMatchmakingConfigurationsResponse |
describeMatchmakingConfigurations()
Retrieves the details of FlexMatch matchmaking configurations.
|
default DescribeMatchmakingConfigurationsResponse |
describeMatchmakingConfigurations(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest)
Retrieves the details of FlexMatch matchmaking configurations.
|
default DescribeMatchmakingConfigurationsResponse |
describeMatchmakingConfigurations(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest)
Retrieves the details of FlexMatch matchmaking configurations.
|
default DescribeMatchmakingConfigurationsIterable |
describeMatchmakingConfigurationsPaginator()
Retrieves the details of FlexMatch matchmaking configurations.
|
default DescribeMatchmakingConfigurationsIterable |
describeMatchmakingConfigurationsPaginator(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest)
Retrieves the details of FlexMatch matchmaking configurations.
|
default DescribeMatchmakingConfigurationsIterable |
describeMatchmakingConfigurationsPaginator(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest)
Retrieves the details of FlexMatch matchmaking configurations.
|
default DescribeMatchmakingRuleSetsResponse |
describeMatchmakingRuleSets()
Retrieves the details for FlexMatch matchmaking rule sets.
|
default DescribeMatchmakingRuleSetsResponse |
describeMatchmakingRuleSets(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest)
Retrieves the details for FlexMatch matchmaking rule sets.
|
default DescribeMatchmakingRuleSetsResponse |
describeMatchmakingRuleSets(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest)
Retrieves the details for FlexMatch matchmaking rule sets.
|
default DescribeMatchmakingRuleSetsIterable |
describeMatchmakingRuleSetsPaginator()
Retrieves the details for FlexMatch matchmaking rule sets.
|
default DescribeMatchmakingRuleSetsIterable |
describeMatchmakingRuleSetsPaginator(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest)
Retrieves the details for FlexMatch matchmaking rule sets.
|
default DescribeMatchmakingRuleSetsIterable |
describeMatchmakingRuleSetsPaginator(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest)
Retrieves the details for FlexMatch matchmaking rule sets.
|
default DescribePlayerSessionsResponse |
describePlayerSessions(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest)
Retrieves properties for one or more player sessions.
|
default DescribePlayerSessionsResponse |
describePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)
Retrieves properties for one or more player sessions.
|
default DescribePlayerSessionsIterable |
describePlayerSessionsPaginator(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest)
Retrieves properties for one or more player sessions.
|
default DescribePlayerSessionsIterable |
describePlayerSessionsPaginator(DescribePlayerSessionsRequest describePlayerSessionsRequest)
Retrieves properties for one or more player sessions.
|
default DescribeRuntimeConfigurationResponse |
describeRuntimeConfiguration(Consumer<DescribeRuntimeConfigurationRequest.Builder> describeRuntimeConfigurationRequest)
Retrieves a fleet's runtime configuration settings.
|
default DescribeRuntimeConfigurationResponse |
describeRuntimeConfiguration(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest)
Retrieves a fleet's runtime configuration settings.
|
default DescribeScalingPoliciesResponse |
describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)
Retrieves all scaling policies applied to a fleet.
|
default DescribeScalingPoliciesResponse |
describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
Retrieves all scaling policies applied to a fleet.
|
default DescribeScalingPoliciesIterable |
describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest)
Retrieves all scaling policies applied to a fleet.
|
default DescribeScalingPoliciesIterable |
describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest)
Retrieves all scaling policies applied to a fleet.
|
default DescribeScriptResponse |
describeScript(Consumer<DescribeScriptRequest.Builder> describeScriptRequest)
Retrieves properties for a Realtime script.
|
default DescribeScriptResponse |
describeScript(DescribeScriptRequest describeScriptRequest)
Retrieves properties for a Realtime script.
|
default DescribeVpcPeeringAuthorizationsResponse |
describeVpcPeeringAuthorizations()
Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
|
default DescribeVpcPeeringAuthorizationsResponse |
describeVpcPeeringAuthorizations(Consumer<DescribeVpcPeeringAuthorizationsRequest.Builder> describeVpcPeeringAuthorizationsRequest)
Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
|
default DescribeVpcPeeringAuthorizationsResponse |
describeVpcPeeringAuthorizations(DescribeVpcPeeringAuthorizationsRequest describeVpcPeeringAuthorizationsRequest)
Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
|
default DescribeVpcPeeringConnectionsResponse |
describeVpcPeeringConnections()
Retrieves information on VPC peering connections.
|
default DescribeVpcPeeringConnectionsResponse |
describeVpcPeeringConnections(Consumer<DescribeVpcPeeringConnectionsRequest.Builder> describeVpcPeeringConnectionsRequest)
Retrieves information on VPC peering connections.
|
default DescribeVpcPeeringConnectionsResponse |
describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest)
Retrieves information on VPC peering connections.
|
default GetComputeAccessResponse |
getComputeAccess(Consumer<GetComputeAccessRequest.Builder> getComputeAccessRequest)
Requests remote access to a fleet instance.
|
default GetComputeAccessResponse |
getComputeAccess(GetComputeAccessRequest getComputeAccessRequest)
Requests remote access to a fleet instance.
|
default GetComputeAuthTokenResponse |
getComputeAuthToken(Consumer<GetComputeAuthTokenRequest.Builder> getComputeAuthTokenRequest)
Requests an authorization token from GameLift.
|
default GetComputeAuthTokenResponse |
getComputeAuthToken(GetComputeAuthTokenRequest getComputeAuthTokenRequest)
Requests an authorization token from GameLift.
|
default GetGameSessionLogUrlResponse |
getGameSessionLogUrl(Consumer<GetGameSessionLogUrlRequest.Builder> getGameSessionLogUrlRequest)
Retrieves the location of stored game session logs for a specified game session.
|
default GetGameSessionLogUrlResponse |
getGameSessionLogUrl(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest)
Retrieves the location of stored game session logs for a specified game session.
|
default GetInstanceAccessResponse |
getInstanceAccess(Consumer<GetInstanceAccessRequest.Builder> getInstanceAccessRequest)
Requests remote access to a fleet instance.
|
default GetInstanceAccessResponse |
getInstanceAccess(GetInstanceAccessRequest getInstanceAccessRequest)
Requests remote access to a fleet instance.
|
default ListAliasesResponse |
listAliases()
Retrieves all aliases for this Amazon Web Services account.
|
default ListAliasesResponse |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Retrieves all aliases for this Amazon Web Services account.
|
default ListAliasesResponse |
listAliases(ListAliasesRequest listAliasesRequest)
Retrieves all aliases for this Amazon Web Services account.
|
default ListAliasesIterable |
listAliasesPaginator()
Retrieves all aliases for this Amazon Web Services account.
|
default ListAliasesIterable |
listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Retrieves all aliases for this Amazon Web Services account.
|
default ListAliasesIterable |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Retrieves all aliases for this Amazon Web Services account.
|
default ListBuildsResponse |
listBuilds()
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
|
default ListBuildsResponse |
listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest)
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
|
default ListBuildsResponse |
listBuilds(ListBuildsRequest listBuildsRequest)
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
|
default ListBuildsIterable |
listBuildsPaginator()
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
|
default ListBuildsIterable |
listBuildsPaginator(Consumer<ListBuildsRequest.Builder> listBuildsRequest)
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
|
default ListBuildsIterable |
listBuildsPaginator(ListBuildsRequest listBuildsRequest)
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
|
default ListComputeResponse |
listCompute(Consumer<ListComputeRequest.Builder> listComputeRequest)
Retrieves all compute resources registered to a fleet in your Amazon Web Services account.
|
default ListComputeResponse |
listCompute(ListComputeRequest listComputeRequest)
Retrieves all compute resources registered to a fleet in your Amazon Web Services account.
|
default ListComputeIterable |
listComputePaginator(Consumer<ListComputeRequest.Builder> listComputeRequest)
Retrieves all compute resources registered to a fleet in your Amazon Web Services account.
|
default ListComputeIterable |
listComputePaginator(ListComputeRequest listComputeRequest)
Retrieves all compute resources registered to a fleet in your Amazon Web Services account.
|
default ListFleetsResponse |
listFleets()
Retrieves a collection of fleet resources in an Amazon Web Services Region.
|
default ListFleetsResponse |
listFleets(Consumer<ListFleetsRequest.Builder> listFleetsRequest)
Retrieves a collection of fleet resources in an Amazon Web Services Region.
|
default ListFleetsResponse |
listFleets(ListFleetsRequest listFleetsRequest)
Retrieves a collection of fleet resources in an Amazon Web Services Region.
|
default ListFleetsIterable |
listFleetsPaginator()
Retrieves a collection of fleet resources in an Amazon Web Services Region.
|
default ListFleetsIterable |
listFleetsPaginator(Consumer<ListFleetsRequest.Builder> listFleetsRequest)
Retrieves a collection of fleet resources in an Amazon Web Services Region.
|
default ListFleetsIterable |
listFleetsPaginator(ListFleetsRequest listFleetsRequest)
Retrieves a collection of fleet resources in an Amazon Web Services Region.
|
default ListGameServerGroupsResponse |
listGameServerGroups(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest)
Lists a game server groups.
|
default ListGameServerGroupsResponse |
listGameServerGroups(ListGameServerGroupsRequest listGameServerGroupsRequest)
Lists a game server groups.
|
default ListGameServerGroupsIterable |
listGameServerGroupsPaginator(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest)
Lists a game server groups.
|
default ListGameServerGroupsIterable |
listGameServerGroupsPaginator(ListGameServerGroupsRequest listGameServerGroupsRequest)
Lists a game server groups.
|
default ListGameServersResponse |
listGameServers(Consumer<ListGameServersRequest.Builder> listGameServersRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default ListGameServersResponse |
listGameServers(ListGameServersRequest listGameServersRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default ListGameServersIterable |
listGameServersPaginator(Consumer<ListGameServersRequest.Builder> listGameServersRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default ListGameServersIterable |
listGameServersPaginator(ListGameServersRequest listGameServersRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default ListLocationsResponse |
listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Lists all custom and Amazon Web Services locations.
|
default ListLocationsResponse |
listLocations(ListLocationsRequest listLocationsRequest)
Lists all custom and Amazon Web Services locations.
|
default ListLocationsIterable |
listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
Lists all custom and Amazon Web Services locations.
|
default ListLocationsIterable |
listLocationsPaginator(ListLocationsRequest listLocationsRequest)
Lists all custom and Amazon Web Services locations.
|
default 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 ListScriptsResponse |
listScripts(ListScriptsRequest listScriptsRequest)
Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in
use.
|
default ListScriptsIterable |
listScriptsPaginator(Consumer<ListScriptsRequest.Builder> listScriptsRequest)
Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in
use.
|
default ListScriptsIterable |
listScriptsPaginator(ListScriptsRequest listScriptsRequest)
Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in
use.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieves all tags that are assigned to a GameLift resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves all tags that are assigned to a GameLift resource.
|
default PutScalingPolicyResponse |
putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest)
Creates or updates a scaling policy for a fleet.
|
default PutScalingPolicyResponse |
putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a scaling policy for a fleet.
|
default RegisterComputeResponse |
registerCompute(Consumer<RegisterComputeRequest.Builder> registerComputeRequest)
Registers your compute resources in a fleet you previously created.
|
default RegisterComputeResponse |
registerCompute(RegisterComputeRequest registerComputeRequest)
Registers your compute resources in a fleet you previously created.
|
default RegisterGameServerResponse |
registerGameServer(Consumer<RegisterGameServerRequest.Builder> registerGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default RegisterGameServerResponse |
registerGameServer(RegisterGameServerRequest registerGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default 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.
|
default 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.
|
default ResolveAliasResponse |
resolveAlias(Consumer<ResolveAliasRequest.Builder> resolveAliasRequest)
Retrieves the fleet ID that an alias is currently pointing to.
|
default ResolveAliasResponse |
resolveAlias(ResolveAliasRequest resolveAliasRequest)
Retrieves the fleet ID that an alias is currently pointing to.
|
default ResumeGameServerGroupResponse |
resumeGameServerGroup(Consumer<ResumeGameServerGroupRequest.Builder> resumeGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default ResumeGameServerGroupResponse |
resumeGameServerGroup(ResumeGameServerGroupRequest resumeGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default 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.
|
default SearchGameSessionsResponse |
searchGameSessions(SearchGameSessionsRequest searchGameSessionsRequest)
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
|
default SearchGameSessionsIterable |
searchGameSessionsPaginator(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest)
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
|
default SearchGameSessionsIterable |
searchGameSessionsPaginator(SearchGameSessionsRequest searchGameSessionsRequest)
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
|
static ServiceMetadata |
serviceMetadata() |
default StartFleetActionsResponse |
startFleetActions(Consumer<StartFleetActionsRequest.Builder> startFleetActionsRequest)
Resumes certain types of activity on fleet instances that were suspended with StopFleetActions.
|
default StartFleetActionsResponse |
startFleetActions(StartFleetActionsRequest startFleetActionsRequest)
Resumes certain types of activity on fleet instances that were suspended with StopFleetActions.
|
default StartGameSessionPlacementResponse |
startGameSessionPlacement(Consumer<StartGameSessionPlacementRequest.Builder> startGameSessionPlacementRequest)
Places a request for a new game session in a queue.
|
default StartGameSessionPlacementResponse |
startGameSessionPlacement(StartGameSessionPlacementRequest startGameSessionPlacementRequest)
Places a request for a new game session in a queue.
|
default StartMatchBackfillResponse |
startMatchBackfill(Consumer<StartMatchBackfillRequest.Builder> startMatchBackfillRequest)
Finds new players to fill open slots in currently running game sessions.
|
default StartMatchBackfillResponse |
startMatchBackfill(StartMatchBackfillRequest startMatchBackfillRequest)
Finds new players to fill open slots in currently running game sessions.
|
default StartMatchmakingResponse |
startMatchmaking(Consumer<StartMatchmakingRequest.Builder> startMatchmakingRequest)
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.
|
default StartMatchmakingResponse |
startMatchmaking(StartMatchmakingRequest startMatchmakingRequest)
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.
|
default StopFleetActionsResponse |
stopFleetActions(Consumer<StopFleetActionsRequest.Builder> stopFleetActionsRequest)
Suspends certain types of activity in a fleet location.
|
default StopFleetActionsResponse |
stopFleetActions(StopFleetActionsRequest stopFleetActionsRequest)
Suspends certain types of activity in a fleet location.
|
default StopGameSessionPlacementResponse |
stopGameSessionPlacement(Consumer<StopGameSessionPlacementRequest.Builder> stopGameSessionPlacementRequest)
Cancels a game session placement that is in
PENDING status. |
default StopGameSessionPlacementResponse |
stopGameSessionPlacement(StopGameSessionPlacementRequest stopGameSessionPlacementRequest)
Cancels a game session placement that is in
PENDING status. |
default StopMatchmakingResponse |
stopMatchmaking(Consumer<StopMatchmakingRequest.Builder> stopMatchmakingRequest)
Cancels a matchmaking ticket or match backfill ticket that is currently being processed.
|
default StopMatchmakingResponse |
stopMatchmaking(StopMatchmakingRequest stopMatchmakingRequest)
Cancels a matchmaking ticket or match backfill ticket that is currently being processed.
|
default SuspendGameServerGroupResponse |
suspendGameServerGroup(Consumer<SuspendGameServerGroupRequest.Builder> suspendGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default SuspendGameServerGroupResponse |
suspendGameServerGroup(SuspendGameServerGroupRequest suspendGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns a tag to a GameLift resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a tag to a GameLift resource.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag that is assigned to a GameLift resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag that is assigned to a GameLift resource.
|
default UpdateAliasResponse |
updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest)
Updates properties for an alias.
|
default UpdateAliasResponse |
updateAlias(UpdateAliasRequest updateAliasRequest)
Updates properties for an alias.
|
default UpdateBuildResponse |
updateBuild(Consumer<UpdateBuildRequest.Builder> updateBuildRequest)
Updates metadata in a build resource, including the build name and version.
|
default UpdateBuildResponse |
updateBuild(UpdateBuildRequest updateBuildRequest)
Updates metadata in a build resource, including the build name and version.
|
default UpdateFleetAttributesResponse |
updateFleetAttributes(Consumer<UpdateFleetAttributesRequest.Builder> updateFleetAttributesRequest)
Updates a fleet's mutable attributes, including game session protection and resource creation limits.
|
default UpdateFleetAttributesResponse |
updateFleetAttributes(UpdateFleetAttributesRequest updateFleetAttributesRequest)
Updates a fleet's mutable attributes, including game session protection and resource creation limits.
|
default UpdateFleetCapacityResponse |
updateFleetCapacity(Consumer<UpdateFleetCapacityRequest.Builder> updateFleetCapacityRequest)
Updates capacity settings for a fleet.
|
default UpdateFleetCapacityResponse |
updateFleetCapacity(UpdateFleetCapacityRequest updateFleetCapacityRequest)
Updates capacity settings for a fleet.
|
default UpdateFleetPortSettingsResponse |
updateFleetPortSettings(Consumer<UpdateFleetPortSettingsRequest.Builder> updateFleetPortSettingsRequest)
Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in
the fleet.
|
default UpdateFleetPortSettingsResponse |
updateFleetPortSettings(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest)
Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in
the fleet.
|
default UpdateGameServerResponse |
updateGameServer(Consumer<UpdateGameServerRequest.Builder> updateGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default UpdateGameServerResponse |
updateGameServer(UpdateGameServerRequest updateGameServerRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default UpdateGameServerGroupResponse |
updateGameServerGroup(Consumer<UpdateGameServerGroupRequest.Builder> updateGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default UpdateGameServerGroupResponse |
updateGameServerGroup(UpdateGameServerGroupRequest updateGameServerGroupRequest)
This operation is used with the GameLift FleetIQ solution and game server groups.
|
default UpdateGameSessionResponse |
updateGameSession(Consumer<UpdateGameSessionRequest.Builder> updateGameSessionRequest)
Updates the mutable properties of a game session.
|
default UpdateGameSessionResponse |
updateGameSession(UpdateGameSessionRequest updateGameSessionRequest)
Updates the mutable properties of a game session.
|
default UpdateGameSessionQueueResponse |
updateGameSessionQueue(Consumer<UpdateGameSessionQueueRequest.Builder> updateGameSessionQueueRequest)
Updates the configuration of a game session queue, which determines how the queue processes new game session
requests.
|
default UpdateGameSessionQueueResponse |
updateGameSessionQueue(UpdateGameSessionQueueRequest updateGameSessionQueueRequest)
Updates the configuration of a game session queue, which determines how the queue processes new game session
requests.
|
default UpdateMatchmakingConfigurationResponse |
updateMatchmakingConfiguration(Consumer<UpdateMatchmakingConfigurationRequest.Builder> updateMatchmakingConfigurationRequest)
Updates settings for a FlexMatch matchmaking configuration.
|
default UpdateMatchmakingConfigurationResponse |
updateMatchmakingConfiguration(UpdateMatchmakingConfigurationRequest updateMatchmakingConfigurationRequest)
Updates settings for a FlexMatch matchmaking configuration.
|
default UpdateRuntimeConfigurationResponse |
updateRuntimeConfiguration(Consumer<UpdateRuntimeConfigurationRequest.Builder> updateRuntimeConfigurationRequest)
Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server
processes on all instances in the fleet.
|
default UpdateRuntimeConfigurationResponse |
updateRuntimeConfiguration(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest)
Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server
processes on all instances in the fleet.
|
default UpdateScriptResponse |
updateScript(Consumer<UpdateScriptRequest.Builder> updateScriptRequest)
Updates Realtime script metadata and content.
|
default UpdateScriptResponse |
updateScript(UpdateScriptRequest updateScriptRequest)
Updates Realtime script metadata and content.
|
default ValidateMatchmakingRuleSetResponse |
validateMatchmakingRuleSet(Consumer<ValidateMatchmakingRuleSetRequest.Builder> validateMatchmakingRuleSetRequest)
Validates the syntax of a matchmaking rule or rule set.
|
default ValidateMatchmakingRuleSetResponse |
validateMatchmakingRuleSet(ValidateMatchmakingRuleSetRequest validateMatchmakingRuleSetRequest)
Validates the syntax of a matchmaking rule or rule set.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static GameLiftClient create()
GameLiftClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static GameLiftClientBuilder builder()
GameLiftClient.default AcceptMatchResponse acceptMatch(AcceptMatchRequest acceptMatchRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 the
ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an
error.
To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have
registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session
is created for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed
match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more
players rejected the match or failed to respond, the ticket status is set to CANCELLED, and
processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is
returned to SEARCHING to find a new match. A new matchmaking request for these players can be
submitted as needed.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
acceptMatchRequest - 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.AwsServiceExceptiondefault AcceptMatchResponse acceptMatch(Consumer<AcceptMatchRequest.Builder> acceptMatchRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 the
ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an
error.
To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have
registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session
is created for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed
match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more
players rejected the match or failed to respond, the ticket status is set to CANCELLED, and
processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is
returned to SEARCHING to find a new match. A new matchmaking request for these players can be
submitted as needed.
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 via AcceptMatchRequest.builder()
acceptMatchRequest - A Consumer that will call methods on AcceptMatchInput.Builder to create a request.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.AwsServiceExceptiondefault ClaimGameServerResponse claimGameServer(ClaimGameServerRequest claimGameServerRequest) throws InvalidRequestException, NotFoundException, ConflictException, OutOfCapacityException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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, 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 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.
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 to CLAIMED for up to
60 seconds. This time period gives the game server time to update its status to UTILIZED 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.
When claiming a specific game server, this request will succeed even if the game server is running on an instance
in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances .
Learn more
claimGameServerRequest - 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.AwsServiceExceptiondefault ClaimGameServerResponse claimGameServer(Consumer<ClaimGameServerRequest.Builder> claimGameServerRequest) throws InvalidRequestException, NotFoundException, ConflictException, OutOfCapacityException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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, 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 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.
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 to CLAIMED for up to
60 seconds. This time period gives the game server time to update its status to UTILIZED 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.
When claiming a specific game server, this request will succeed even if the game server is running on an instance
in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances .
Learn more
This is a convenience which creates an instance of the ClaimGameServerRequest.Builder avoiding the need
to create one manually via ClaimGameServerRequest.builder()
claimGameServerRequest - A Consumer that will call methods on ClaimGameServerInput.Builder to create a request.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.AwsServiceExceptiondefault CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, InternalServiceException, LimitExceededException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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
createAliasRequest - 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.AwsServiceExceptiondefault CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, InternalServiceException, LimitExceededException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 via CreateAliasRequest.builder()
createAliasRequest - A Consumer that will call methods on CreateAliasInput.Builder to create a request.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.AwsServiceExceptiondefault CreateBuildResponse createBuild(CreateBuildRequest createBuildRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 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 a GameLift Amazon S3 location, and (2) it creates a new build resource.
You can use the operation in the following scenarios:
To 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.
To directly upload your build files to a 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 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 in READY status before you can create fleets with
it.
Learn more
createBuildRequest - 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.AwsServiceExceptiondefault CreateBuildResponse createBuild(Consumer<CreateBuildRequest.Builder> createBuildRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 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 a GameLift Amazon S3 location, and (2) it creates a new build resource.
You can use the operation in the following scenarios:
To 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.
To directly upload your build files to a 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 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 in READY 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 via CreateBuildRequest.builder()
createBuildRequest - A Consumer that will call methods on CreateBuildInput.Builder to create a request.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.AwsServiceExceptiondefault CreateFleetResponse createFleet(CreateFleetRequest createFleetRequest) throws InternalServiceException, NotFoundException, ConflictException, LimitExceededException, InvalidRequestException, UnauthorizedException, TaggingFailedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.
Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.
To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.
If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the 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.
If successful, this operation creates a new Fleet resource and places it in NEW status, which
prompts GameLift to initiate the fleet creation
workflow.
Learn more
createFleetRequest - 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.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.AwsServiceExceptiondefault CreateFleetResponse createFleet(Consumer<CreateFleetRequest.Builder> createFleetRequest) throws InternalServiceException, NotFoundException, ConflictException, LimitExceededException, InvalidRequestException, UnauthorizedException, TaggingFailedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.
Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.
To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.
If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the 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.
If successful, this operation creates a new Fleet resource and places it in NEW status, which
prompts GameLift to initiate the fleet creation
workflow.
Learn more
This is a convenience which creates an instance of the CreateFleetRequest.Builder avoiding the need to
create one manually via CreateFleetRequest.builder()
createFleetRequest - A Consumer that will call methods on CreateFleetInput.Builder to create a request.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.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.AwsServiceExceptiondefault CreateFleetLocationsResponse createFleetLocations(CreateFleetLocationsRequest createFleetLocationsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, InvalidFleetStatusException, UnsupportedRegionException, ConflictException, AwsServiceException, SdkClientException, GameLiftException
Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.
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.
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
createFleetLocationsRequest - 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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GameLiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFleetLocationsResponse createFleetLocations(Consumer<CreateFleetLocationsRequest.Builder> createFleetLocationsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, InvalidFleetStatusException, UnsupportedRegionException, ConflictException, AwsServiceException, SdkClientException, GameLiftException
Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature and were created after the feature was released in March 2021.
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.
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 via CreateFleetLocationsRequest.builder()
createFleetLocationsRequest - A Consumer that will call methods on CreateFleetLocationsInput.Builder to create a
request.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.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GameLiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGameServerGroupResponse createGameServerGroup(CreateGameServerGroupRequest createGameServerGroupRequest) throws InvalidRequestException, ConflictException, UnauthorizedException, InternalServiceException, LimitExceededException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a 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 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 GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the 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 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 GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
createGameServerGroupRequest - 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.AwsServiceExceptiondefault CreateGameServerGroupResponse createGameServerGroup(Consumer<CreateGameServerGroupRequest.Builder> createGameServerGroupRequest) throws InvalidRequestException, ConflictException, UnauthorizedException, InternalServiceException, LimitExceededException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a 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 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 GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the 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 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 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 via CreateGameServerGroupRequest.builder()
createGameServerGroupRequest - A Consumer that will call methods on CreateGameServerGroupInput.Builder to create a
request.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.AwsServiceExceptiondefault CreateGameSessionResponse createGameSession(CreateGameSessionRequest createGameSessionRequest) throws ConflictException, InternalServiceException, UnauthorizedException, InvalidFleetStatusException, TerminalRoutingStrategyException, InvalidRequestException, NotFoundException, FleetCapacityExceededException, LimitExceededException, IdempotentParameterMismatchException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms 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 fleet must be in ACTIVE status before a game session can be created in
it.
This operation can be used 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.
If successful, a workflow is initiated to start a new game session. A GameSession object is returned
containing the game session configuration and status. When the status is ACTIVE, game session
connection information is provided and player sessions can be created 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.
Game session logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
Learn more
createGameSessionRequest - 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.AwsServiceExceptiondefault CreateGameSessionResponse createGameSession(Consumer<CreateGameSessionRequest.Builder> createGameSessionRequest) throws ConflictException, InternalServiceException, UnauthorizedException, InvalidFleetStatusException, TerminalRoutingStrategyException, InvalidRequestException, NotFoundException, FleetCapacityExceededException, LimitExceededException, IdempotentParameterMismatchException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 GameLift game session placement feature with StartGameSessionPlacement , which uses FleetIQ algorithms 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 fleet must be in ACTIVE status before a game session can be created in
it.
This operation can be used 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.
If successful, a workflow is initiated to start a new game session. A GameSession object is returned
containing the game session configuration and status. When the status is ACTIVE, game session
connection information is provided and player sessions can be created 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.
Game session logs are retained for all active game sessions 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 via CreateGameSessionRequest.builder()
createGameSessionRequest - A Consumer that will call methods on CreateGameSessionInput.Builder to create a request.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.AwsServiceExceptiondefault CreateGameSessionQueueResponse createGameSessionQueue(CreateGameSessionQueueRequest createGameSessionQueueRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, LimitExceededException, NotFoundException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 (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
createGameSessionQueueRequest - 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.AwsServiceExceptiondefault CreateGameSessionQueueResponse createGameSessionQueue(Consumer<CreateGameSessionQueueRequest.Builder> createGameSessionQueueRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, LimitExceededException, NotFoundException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 (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 via CreateGameSessionQueueRequest.builder()
createGameSessionQueueRequest - A Consumer that will call methods on CreateGameSessionQueueInput.Builder to create a
request.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.AwsServiceExceptiondefault CreateLocationResponse createLocation(CreateLocationRequest createLocationRequest) throws UnauthorizedException, InvalidRequestException, LimitExceededException, ConflictException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Creates a custom location for use in an Anywhere fleet.
createLocationRequest - 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.AwsServiceExceptiondefault CreateLocationResponse createLocation(Consumer<CreateLocationRequest.Builder> createLocationRequest) throws UnauthorizedException, InvalidRequestException, LimitExceededException, ConflictException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via CreateLocationRequest.builder()
createLocationRequest - A Consumer that will call methods on CreateLocationInput.Builder to create a request.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.AwsServiceExceptiondefault CreateMatchmakingConfigurationResponse createMatchmakingConfiguration(CreateMatchmakingConfigurationRequest createMatchmakingConfigurationRequest) throws InvalidRequestException, LimitExceededException, NotFoundException, InternalServiceException, UnsupportedRegionException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with 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 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 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 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
createMatchmakingConfigurationRequest - 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.AwsServiceExceptiondefault CreateMatchmakingConfigurationResponse createMatchmakingConfiguration(Consumer<CreateMatchmakingConfigurationRequest.Builder> createMatchmakingConfigurationRequest) throws InvalidRequestException, LimitExceededException, NotFoundException, InternalServiceException, UnsupportedRegionException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with 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 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 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 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 via CreateMatchmakingConfigurationRequest.builder()
createMatchmakingConfigurationRequest - A Consumer that will call methods on CreateMatchmakingConfigurationInput.Builder to create
a request.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.AwsServiceExceptiondefault CreateMatchmakingRuleSetResponse createMatchmakingRuleSet(CreateMatchmakingRuleSetRequest createMatchmakingRuleSetRequest) throws InvalidRequestException, LimitExceededException, InternalServiceException, UnsupportedRegionException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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
createMatchmakingRuleSetRequest - 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.AwsServiceExceptiondefault CreateMatchmakingRuleSetResponse createMatchmakingRuleSet(Consumer<CreateMatchmakingRuleSetRequest.Builder> createMatchmakingRuleSetRequest) throws InvalidRequestException, LimitExceededException, InternalServiceException, UnsupportedRegionException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 via CreateMatchmakingRuleSetRequest.builder()
createMatchmakingRuleSetRequest - A Consumer that will call methods on CreateMatchmakingRuleSetInput.Builder to create a
request.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.AwsServiceExceptiondefault CreatePlayerSessionResponse createPlayerSession(CreatePlayerSessionRequest createPlayerSessionRequest) throws InternalServiceException, UnauthorizedException, InvalidGameSessionStatusException, GameSessionFullException, TerminalRoutingStrategyException, InvalidRequestException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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 of
ACCEPT_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 GameLift
service. Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
createPlayerSessionRequest - 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.AwsServiceExceptiondefault CreatePlayerSessionResponse createPlayerSession(Consumer<CreatePlayerSessionRequest.Builder> createPlayerSessionRequest) throws InternalServiceException, UnauthorizedException, InvalidGameSessionStatusException, GameSessionFullException, TerminalRoutingStrategyException, InvalidRequestException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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 of
ACCEPT_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 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 via CreatePlayerSessionRequest.builder()
createPlayerSessionRequest - A Consumer that will call methods on CreatePlayerSessionInput.Builder to create a 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.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.AwsServiceExceptiondefault CreatePlayerSessionsResponse createPlayerSessions(CreatePlayerSessionsRequest createPlayerSessionsRequest) throws InternalServiceException, UnauthorizedException, InvalidGameSessionStatusException, GameSessionFullException, TerminalRoutingStrategyException, InvalidRequestException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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 of
ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession
To 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 GameLift
service. Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
createPlayerSessionsRequest - 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.AwsServiceExceptiondefault CreatePlayerSessionsResponse createPlayerSessions(Consumer<CreatePlayerSessionsRequest.Builder> createPlayerSessionsRequest) throws InternalServiceException, UnauthorizedException, InvalidGameSessionStatusException, GameSessionFullException, TerminalRoutingStrategyException, InvalidRequestException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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 of
ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession
To 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 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 via CreatePlayerSessionsRequest.builder()
createPlayerSessionsRequest - A Consumer that will call methods on CreatePlayerSessionsInput.Builder to create a
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.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.AwsServiceExceptiondefault CreateScriptResponse createScript(CreateScriptRequest createScriptRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
createScriptRequest - 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.AwsServiceExceptiondefault CreateScriptResponse createScript(Consumer<CreateScriptRequest.Builder> createScriptRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via CreateScriptRequest.builder()
createScriptRequest - A Consumer that will call methods on CreateScriptInput.Builder to create a request.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.AwsServiceExceptiondefault CreateVpcPeeringAuthorizationResponse createVpcPeeringAuthorization(CreateVpcPeeringAuthorizationRequest createVpcPeeringAuthorizationRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
createVpcPeeringAuthorizationRequest - 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.AwsServiceExceptiondefault CreateVpcPeeringAuthorizationResponse createVpcPeeringAuthorization(Consumer<CreateVpcPeeringAuthorizationRequest.Builder> createVpcPeeringAuthorizationRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via CreateVpcPeeringAuthorizationRequest.builder()
createVpcPeeringAuthorizationRequest - A Consumer that will call methods on CreateVpcPeeringAuthorizationInput.Builder to create
a request.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.AwsServiceExceptiondefault CreateVpcPeeringConnectionResponse createVpcPeeringConnection(CreateVpcPeeringConnectionRequest createVpcPeeringConnectionRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
createVpcPeeringConnectionRequest - 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.AwsServiceExceptiondefault CreateVpcPeeringConnectionResponse createVpcPeeringConnection(Consumer<CreateVpcPeeringConnectionRequest.Builder> createVpcPeeringConnectionRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via CreateVpcPeeringConnectionRequest.builder()
createVpcPeeringConnectionRequest - A Consumer that will call methods on CreateVpcPeeringConnectionInput.Builder to create a
request.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.AwsServiceExceptiondefault DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws UnauthorizedException, NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
deleteAliasRequest - 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.AwsServiceExceptiondefault DeleteAliasResponse deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) throws UnauthorizedException, NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteAliasRequest.builder()
deleteAliasRequest - A Consumer that will call methods on DeleteAliasInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteBuildResponse deleteBuild(DeleteBuildRequest deleteBuildRequest) throws UnauthorizedException, NotFoundException, InternalServiceException, TaggingFailedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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
deleteBuildRequest - 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.AwsServiceExceptiondefault DeleteBuildResponse deleteBuild(Consumer<DeleteBuildRequest.Builder> deleteBuildRequest) throws UnauthorizedException, NotFoundException, InternalServiceException, TaggingFailedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteBuildRequest.builder()
deleteBuildRequest - A Consumer that will call methods on DeleteBuildInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteFleetResponse deleteFleet(DeleteFleetRequest deleteFleetRequest) throws NotFoundException, InternalServiceException, InvalidFleetStatusException, UnauthorizedException, InvalidRequestException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
Deletes all resources and information related a fleet. Any current fleet instances, including those in remote
locations, are shut down. You don't need to call DeleteFleetLocations separately.
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 do not 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 to TERMINATED and the fleet event
FLEET_DELETED is sent.
Learn more
deleteFleetRequest - 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.AwsServiceExceptiondefault DeleteFleetResponse deleteFleet(Consumer<DeleteFleetRequest.Builder> deleteFleetRequest) throws NotFoundException, InternalServiceException, InvalidFleetStatusException, UnauthorizedException, InvalidRequestException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
Deletes all resources and information related a fleet. Any current fleet instances, including those in remote
locations, are shut down. You don't need to call DeleteFleetLocations separately.
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 do not 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 to TERMINATED and the fleet event
FLEET_DELETED is sent.
Learn more
This is a convenience which creates an instance of the DeleteFleetRequest.Builder avoiding the need to
create one manually via DeleteFleetRequest.builder()
deleteFleetRequest - A Consumer that will call methods on DeleteFleetInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteFleetLocationsResponse deleteFleetLocations(DeleteFleetLocationsRequest deleteFleetLocationsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 to TERMINATED.
Learn more
deleteFleetLocationsRequest - 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.AwsServiceExceptiondefault DeleteFleetLocationsResponse deleteFleetLocations(Consumer<DeleteFleetLocationsRequest.Builder> deleteFleetLocationsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 to TERMINATED.
Learn more
This is a convenience which creates an instance of the DeleteFleetLocationsRequest.Builder avoiding the
need to create one manually via DeleteFleetLocationsRequest.builder()
deleteFleetLocationsRequest - A Consumer that will call methods on DeleteFleetLocationsInput.Builder to create a
request.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.AwsServiceExceptiondefault DeleteGameServerGroupResponse deleteGameServerGroup(DeleteGameServerGroupRequest deleteGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 or ERROR
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, GameLift FleetIQ can
begin deleting resources. If any of the delete operations fail, the game server group is placed in
ERROR status.
GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
deleteGameServerGroupRequest - 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.AwsServiceExceptiondefault DeleteGameServerGroupResponse deleteGameServerGroup(Consumer<DeleteGameServerGroupRequest.Builder> deleteGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 or ERROR
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, GameLift FleetIQ can
begin deleting resources. If any of the delete operations fail, the game server group is placed in
ERROR status.
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 via DeleteGameServerGroupRequest.builder()
deleteGameServerGroupRequest - A Consumer that will call methods on DeleteGameServerGroupInput.Builder to create a
request.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.AwsServiceExceptiondefault DeleteGameSessionQueueResponse deleteGameSessionQueue(DeleteGameSessionQueueRequest deleteGameSessionQueueRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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.
deleteGameSessionQueueRequest - 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.AwsServiceExceptiondefault DeleteGameSessionQueueResponse deleteGameSessionQueue(Consumer<DeleteGameSessionQueueRequest.Builder> deleteGameSessionQueueRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteGameSessionQueueRequest.builder()
deleteGameSessionQueueRequest - A Consumer that will call methods on DeleteGameSessionQueueInput.Builder to create a
request.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.AwsServiceExceptiondefault DeleteLocationResponse deleteLocation(DeleteLocationRequest deleteLocationRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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.
deleteLocationRequest - 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.AwsServiceExceptiondefault DeleteLocationResponse deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteLocationRequest.builder()
deleteLocationRequest - A Consumer that will call methods on DeleteLocationInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteMatchmakingConfigurationResponse deleteMatchmakingConfiguration(DeleteMatchmakingConfigurationRequest deleteMatchmakingConfigurationRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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.
deleteMatchmakingConfigurationRequest - 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.AwsServiceExceptiondefault DeleteMatchmakingConfigurationResponse deleteMatchmakingConfiguration(Consumer<DeleteMatchmakingConfigurationRequest.Builder> deleteMatchmakingConfigurationRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteMatchmakingConfigurationRequest.builder()
deleteMatchmakingConfigurationRequest - A Consumer that will call methods on DeleteMatchmakingConfigurationInput.Builder to create
a request.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.AwsServiceExceptiondefault DeleteMatchmakingRuleSetResponse deleteMatchmakingRuleSet(DeleteMatchmakingRuleSetRequest deleteMatchmakingRuleSetRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, NotFoundException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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
deleteMatchmakingRuleSetRequest - 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.AwsServiceExceptiondefault DeleteMatchmakingRuleSetResponse deleteMatchmakingRuleSet(Consumer<DeleteMatchmakingRuleSetRequest.Builder> deleteMatchmakingRuleSetRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, NotFoundException, TaggingFailedException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteMatchmakingRuleSetRequest.builder()
deleteMatchmakingRuleSetRequest - A Consumer that will call methods on DeleteMatchmakingRuleSetInput.Builder to create a
request.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.AwsServiceExceptiondefault DeleteScalingPolicyResponse deleteScalingPolicy(DeleteScalingPolicyRequest deleteScalingPolicyRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and 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.
deleteScalingPolicyRequest - 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.AwsServiceExceptiondefault DeleteScalingPolicyResponse deleteScalingPolicy(Consumer<DeleteScalingPolicyRequest.Builder> deleteScalingPolicyRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and 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 via DeleteScalingPolicyRequest.builder()
deleteScalingPolicyRequest - A Consumer that will call methods on DeleteScalingPolicyInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteScriptResponse deleteScript(DeleteScriptRequest deleteScriptRequest) throws InvalidRequestException, UnauthorizedException, NotFoundException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
deleteScriptRequest - 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.AwsServiceExceptiondefault DeleteScriptResponse deleteScript(Consumer<DeleteScriptRequest.Builder> deleteScriptRequest) throws InvalidRequestException, UnauthorizedException, NotFoundException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteScriptRequest.builder()
deleteScriptRequest - A Consumer that will call methods on DeleteScriptInput.Builder to create a request.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.AwsServiceExceptiondefault DeleteVpcPeeringAuthorizationResponse deleteVpcPeeringAuthorization(DeleteVpcPeeringAuthorizationRequest deleteVpcPeeringAuthorizationRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.
Related actions
deleteVpcPeeringAuthorizationRequest - 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.AwsServiceExceptiondefault DeleteVpcPeeringAuthorizationResponse deleteVpcPeeringAuthorization(Consumer<DeleteVpcPeeringAuthorizationRequest.Builder> deleteVpcPeeringAuthorizationRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteVpcPeeringAuthorizationRequest.builder()
deleteVpcPeeringAuthorizationRequest - A Consumer that will call methods on DeleteVpcPeeringAuthorizationInput.Builder to create
a request.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.AwsServiceExceptiondefault DeleteVpcPeeringConnectionResponse deleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest deleteVpcPeeringConnectionRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
deleteVpcPeeringConnectionRequest - 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.AwsServiceExceptiondefault DeleteVpcPeeringConnectionResponse deleteVpcPeeringConnection(Consumer<DeleteVpcPeeringConnectionRequest.Builder> deleteVpcPeeringConnectionRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DeleteVpcPeeringConnectionRequest.builder()
deleteVpcPeeringConnectionRequest - A Consumer that will call methods on DeleteVpcPeeringConnectionInput.Builder to create a
request.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.AwsServiceExceptiondefault DeregisterComputeResponse deregisterCompute(DeregisterComputeRequest deregisterComputeRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Removes a compute resource from the specified fleet. Deregister your compute resources before you delete the compute.
deregisterComputeRequest - 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.AwsServiceExceptiondefault DeregisterComputeResponse deregisterCompute(Consumer<DeregisterComputeRequest.Builder> deregisterComputeRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Removes a compute resource from the specified fleet. Deregister your compute resources before you delete the compute.
This is a convenience which creates an instance of the DeregisterComputeRequest.Builder avoiding the need
to create one manually via DeregisterComputeRequest.builder()
deregisterComputeRequest - A Consumer that will call methods on DeregisterComputeInput.Builder to create a request.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.AwsServiceExceptiondefault DeregisterGameServerResponse deregisterGameServer(DeregisterGameServerRequest deregisterGameServerRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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
deregisterGameServerRequest - 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.AwsServiceExceptiondefault DeregisterGameServerResponse deregisterGameServer(Consumer<DeregisterGameServerRequest.Builder> deregisterGameServerRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 via DeregisterGameServerRequest.builder()
deregisterGameServerRequest - A Consumer that will call methods on DeregisterGameServerInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeAliasResponse describeAlias(DescribeAliasRequest describeAliasRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
describeAliasRequest - 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.AwsServiceExceptiondefault DescribeAliasResponse describeAlias(Consumer<DescribeAliasRequest.Builder> describeAliasRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeAliasRequest.builder()
describeAliasRequest - A Consumer that will call methods on DescribeAliasInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeBuildResponse describeBuild(DescribeBuildRequest describeBuildRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
describeBuildRequest - 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.AwsServiceExceptiondefault DescribeBuildResponse describeBuild(Consumer<DescribeBuildRequest.Builder> describeBuildRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeBuildRequest.builder()
describeBuildRequest - A Consumer that will call methods on DescribeBuildInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeComputeResponse describeCompute(DescribeComputeRequest describeComputeRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.
describeComputeRequest - 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.AwsServiceExceptiondefault DescribeComputeResponse describeCompute(Consumer<DescribeComputeRequest.Builder> describeComputeRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.
This is a convenience which creates an instance of the DescribeComputeRequest.Builder avoiding the need
to create one manually via DescribeComputeRequest.builder()
describeComputeRequest - A Consumer that will call methods on DescribeComputeInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeEc2InstanceLimitsResponse describeEC2InstanceLimits() throws InvalidRequestException, InternalServiceException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 GameLift fleets. You can request a limit increase for your account by using the Service limits page in the 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 in us-east-2, by all of the fleets that reside in
ap-northeast-1.
Request specifies the Region us-east-1 with location ca-central-1. The result is limits
and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that
reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to
ca-central-1.
Request specifies the Region eu-west-1 with location ca-central-1. The result is limits
and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that
reside in eu-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
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.AwsServiceExceptiondescribeEC2InstanceLimits(DescribeEc2InstanceLimitsRequest),
AWS API Documentationdefault DescribeEc2InstanceLimitsResponse describeEC2InstanceLimits(DescribeEc2InstanceLimitsRequest describeEc2InstanceLimitsRequest) throws InvalidRequestException, InternalServiceException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 GameLift fleets. You can request a limit increase for your account by using the Service limits page in the 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 in us-east-2, by all of the fleets that reside in
ap-northeast-1.
Request specifies the Region us-east-1 with location ca-central-1. The result is limits
and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that
reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to
ca-central-1.
Request specifies the Region eu-west-1 with location ca-central-1. The result is limits
and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that
reside in eu-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
describeEc2InstanceLimitsRequest - 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.AwsServiceExceptiondefault DescribeEc2InstanceLimitsResponse describeEC2InstanceLimits(Consumer<DescribeEc2InstanceLimitsRequest.Builder> describeEc2InstanceLimitsRequest) throws InvalidRequestException, InternalServiceException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 GameLift fleets. You can request a limit increase for your account by using the Service limits page in the 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 in us-east-2, by all of the fleets that reside in
ap-northeast-1.
Request specifies the Region us-east-1 with location ca-central-1. The result is limits
and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that
reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to
ca-central-1.
Request specifies the Region eu-west-1 with location ca-central-1. The result is limits
and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that
reside in eu-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
This is a convenience which creates an instance of the DescribeEc2InstanceLimitsRequest.Builder avoiding
the need to create one manually via DescribeEc2InstanceLimitsRequest.builder()
describeEc2InstanceLimitsRequest - A Consumer that will call methods on DescribeEC2InstanceLimitsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetAttributesResponse describeFleetAttributes() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more 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
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.AwsServiceExceptiondescribeFleetAttributes(DescribeFleetAttributesRequest),
AWS API Documentationdefault DescribeFleetAttributesResponse describeFleetAttributes(DescribeFleetAttributesRequest describeFleetAttributesRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more 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
describeFleetAttributesRequest - 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.AwsServiceExceptiondefault DescribeFleetAttributesResponse describeFleetAttributes(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more 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
This is a convenience which creates an instance of the DescribeFleetAttributesRequest.Builder avoiding
the need to create one manually via DescribeFleetAttributesRequest.builder()
describeFleetAttributesRequest - A Consumer that will call methods on DescribeFleetAttributesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetAttributesIterable describeFleetAttributesPaginator() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more 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
This is a variant of
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client.describeFleetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client
.describeFleetAttributesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client.describeFleetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeFleetAttributesPaginator(DescribeFleetAttributesRequest),
AWS API Documentationdefault DescribeFleetAttributesIterable describeFleetAttributesPaginator(DescribeFleetAttributesRequest describeFleetAttributesRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more 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
This is a variant of
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client.describeFleetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client
.describeFleetAttributesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client.describeFleetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeFleetAttributesRequest - 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.AwsServiceExceptiondefault DescribeFleetAttributesIterable describeFleetAttributesPaginator(Consumer<DescribeFleetAttributesRequest.Builder> describeFleetAttributesRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more 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
This is a variant of
describeFleetAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client.describeFleetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client
.describeFleetAttributesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetAttributesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetAttributesIterable responses = client.describeFleetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeFleetAttributesRequest.builder()
describeFleetAttributesRequest - A Consumer that will call methods on DescribeFleetAttributesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetCapacityResponse describeFleetCapacity() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
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. Each FleetCapacity
object includes a Location property, which is set to the fleet's home Region. When a list of fleet
IDs is provided, attribute objects 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
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.AwsServiceExceptiondescribeFleetCapacity(DescribeFleetCapacityRequest),
AWS API Documentationdefault DescribeFleetCapacityResponse describeFleetCapacity(DescribeFleetCapacityRequest describeFleetCapacityRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
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. Each FleetCapacity
object includes a Location property, which is set to the fleet's home Region. When a list of fleet
IDs is provided, attribute objects 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
describeFleetCapacityRequest - 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.AwsServiceExceptiondefault DescribeFleetCapacityResponse describeFleetCapacity(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
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. Each FleetCapacity
object includes a Location property, which is set to the fleet's home Region. When a list of fleet
IDs is provided, attribute objects 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
This is a convenience which creates an instance of the DescribeFleetCapacityRequest.Builder avoiding the
need to create one manually via DescribeFleetCapacityRequest.builder()
describeFleetCapacityRequest - A Consumer that will call methods on DescribeFleetCapacityInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetCapacityIterable describeFleetCapacityPaginator() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
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. Each FleetCapacity
object includes a Location property, which is set to the fleet's home Region. When a list of fleet
IDs is provided, attribute objects 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
This is a variant of
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client.describeFleetCapacityPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client
.describeFleetCapacityPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client.describeFleetCapacityPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeFleetCapacityPaginator(DescribeFleetCapacityRequest),
AWS API Documentationdefault DescribeFleetCapacityIterable describeFleetCapacityPaginator(DescribeFleetCapacityRequest describeFleetCapacityRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
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. Each FleetCapacity
object includes a Location property, which is set to the fleet's home Region. When a list of fleet
IDs is provided, attribute objects 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
This is a variant of
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client.describeFleetCapacityPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client
.describeFleetCapacityPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client.describeFleetCapacityPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeFleetCapacityRequest - 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.AwsServiceExceptiondefault DescribeFleetCapacityIterable describeFleetCapacityPaginator(Consumer<DescribeFleetCapacityRequest.Builder> describeFleetCapacityRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
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. Each FleetCapacity
object includes a Location property, which is set to the fleet's home Region. When a list of fleet
IDs is provided, attribute objects 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
This is a variant of
describeFleetCapacity(software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client.describeFleetCapacityPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client
.describeFleetCapacityPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetCapacityResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetCapacityIterable responses = client.describeFleetCapacityPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeFleetCapacityRequest.builder()
describeFleetCapacityRequest - A Consumer that will call methods on DescribeFleetCapacityInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetEventsResponse describeFleetEvents(DescribeFleetEventsRequest describeFleetEventsRequest) throws NotFoundException, InternalServiceException, UnauthorizedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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
describeFleetEventsRequest - 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.AwsServiceExceptiondefault DescribeFleetEventsResponse describeFleetEvents(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest) throws NotFoundException, InternalServiceException, UnauthorizedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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
This is a convenience which creates an instance of the DescribeFleetEventsRequest.Builder avoiding the
need to create one manually via DescribeFleetEventsRequest.builder()
describeFleetEventsRequest - A Consumer that will call methods on DescribeFleetEventsInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeFleetEventsIterable describeFleetEventsPaginator(DescribeFleetEventsRequest describeFleetEventsRequest) throws NotFoundException, InternalServiceException, UnauthorizedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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
This is a variant of
describeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsIterable responses = client.describeFleetEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsIterable responses = client
.describeFleetEventsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsIterable responses = client.describeFleetEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeFleetEventsRequest - 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.AwsServiceExceptiondefault DescribeFleetEventsIterable describeFleetEventsPaginator(Consumer<DescribeFleetEventsRequest.Builder> describeFleetEventsRequest) throws NotFoundException, InternalServiceException, UnauthorizedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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
This is a variant of
describeFleetEvents(software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsIterable responses = client.describeFleetEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsIterable responses = client
.describeFleetEventsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetEventsIterable responses = client.describeFleetEventsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeFleetEventsRequest.builder()
describeFleetEventsRequest - A Consumer that will call methods on DescribeFleetEventsInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeFleetLocationAttributesResponse describeFleetLocationAttributes(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, call DescribeFleetAttributes.
Learn more
describeFleetLocationAttributesRequest - 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.AwsServiceExceptiondefault DescribeFleetLocationAttributesResponse describeFleetLocationAttributes(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, call DescribeFleetAttributes.
Learn more
This is a convenience which creates an instance of the DescribeFleetLocationAttributesRequest.Builder
avoiding the need to create one manually via DescribeFleetLocationAttributesRequest.builder()
describeFleetLocationAttributesRequest - A Consumer that will call methods on DescribeFleetLocationAttributesInput.Builder to
create a request.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.AwsServiceExceptiondefault DescribeFleetLocationAttributesIterable describeFleetLocationAttributesPaginator(DescribeFleetLocationAttributesRequest describeFleetLocationAttributesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, call DescribeFleetAttributes.
Learn more
This is a variant of
describeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesIterable responses = client.describeFleetLocationAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesIterable responses = client
.describeFleetLocationAttributesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesIterable responses = client.describeFleetLocationAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeFleetLocationAttributesRequest - 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.AwsServiceExceptiondefault DescribeFleetLocationAttributesIterable describeFleetLocationAttributesPaginator(Consumer<DescribeFleetLocationAttributesRequest.Builder> describeFleetLocationAttributesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, call DescribeFleetAttributes.
Learn more
This is a variant of
describeFleetLocationAttributes(software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesIterable responses = client.describeFleetLocationAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesIterable responses = client
.describeFleetLocationAttributesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetLocationAttributesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetLocationAttributesIterable responses = client.describeFleetLocationAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeFleetLocationAttributesRequest.builder()
describeFleetLocationAttributesRequest - A Consumer that will call methods on DescribeFleetLocationAttributesInput.Builder to
create a request.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.AwsServiceExceptiondefault DescribeFleetLocationCapacityResponse describeFleetLocationCapacity(DescribeFleetLocationCapacityRequest describeFleetLocationCapacityRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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. 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
describeFleetLocationCapacityRequest - 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.AwsServiceExceptiondefault DescribeFleetLocationCapacityResponse describeFleetLocationCapacity(Consumer<DescribeFleetLocationCapacityRequest.Builder> describeFleetLocationCapacityRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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. 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
This is a convenience which creates an instance of the DescribeFleetLocationCapacityRequest.Builder
avoiding the need to create one manually via DescribeFleetLocationCapacityRequest.builder()
describeFleetLocationCapacityRequest - A Consumer that will call methods on DescribeFleetLocationCapacityInput.Builder to create
a request.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.AwsServiceExceptiondefault DescribeFleetLocationUtilizationResponse describeFleetLocationUtilization(DescribeFleetLocationUtilizationRequest describeFleetLocationUtilizationRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
describeFleetLocationUtilizationRequest - 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.AwsServiceExceptiondefault DescribeFleetLocationUtilizationResponse describeFleetLocationUtilization(Consumer<DescribeFleetLocationUtilizationRequest.Builder> describeFleetLocationUtilizationRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
This is a convenience which creates an instance of the DescribeFleetLocationUtilizationRequest.Builder
avoiding the need to create one manually via DescribeFleetLocationUtilizationRequest.builder()
describeFleetLocationUtilizationRequest - A Consumer that will call methods on DescribeFleetLocationUtilizationInput.Builder to
create a request.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.AwsServiceExceptiondefault DescribeFleetPortSettingsResponse describeFleetPortSettings(DescribeFleetPortSettingsRequest describeFleetPortSettingsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.
This operation can be used in the following ways:
To retrieve the inbound connection permissions 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 a location
is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.
Learn more
describeFleetPortSettingsRequest - 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.AwsServiceExceptiondefault DescribeFleetPortSettingsResponse describeFleetPortSettings(Consumer<DescribeFleetPortSettingsRequest.Builder> describeFleetPortSettingsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.
This operation can be used in the following ways:
To retrieve the inbound connection permissions 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 a location
is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.
Learn more
This is a convenience which creates an instance of the DescribeFleetPortSettingsRequest.Builder avoiding
the need to create one manually via DescribeFleetPortSettingsRequest.builder()
describeFleetPortSettingsRequest - A Consumer that will call methods on DescribeFleetPortSettingsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetUtilizationResponse describeFleetUtilization() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptiondescribeFleetUtilization(DescribeFleetUtilizationRequest),
AWS API Documentationdefault DescribeFleetUtilizationResponse describeFleetUtilization(DescribeFleetUtilizationRequest describeFleetUtilizationRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
describeFleetUtilizationRequest - 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.AwsServiceExceptiondefault DescribeFleetUtilizationResponse describeFleetUtilization(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
This is a convenience which creates an instance of the DescribeFleetUtilizationRequest.Builder avoiding
the need to create one manually via DescribeFleetUtilizationRequest.builder()
describeFleetUtilizationRequest - A Consumer that will call methods on DescribeFleetUtilizationInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeFleetUtilizationIterable describeFleetUtilizationPaginator() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
This is a variant of
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client.describeFleetUtilizationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client
.describeFleetUtilizationPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client.describeFleetUtilizationPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeFleetUtilizationPaginator(DescribeFleetUtilizationRequest),
AWS API Documentationdefault DescribeFleetUtilizationIterable describeFleetUtilizationPaginator(DescribeFleetUtilizationRequest describeFleetUtilizationRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
This is a variant of
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client.describeFleetUtilizationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client
.describeFleetUtilizationPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client.describeFleetUtilizationPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeFleetUtilizationRequest - 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.AwsServiceExceptiondefault DescribeFleetUtilizationIterable describeFleetUtilizationPaginator(Consumer<DescribeFleetUtilizationRequest.Builder> describeFleetUtilizationRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
This is a variant of
describeFleetUtilization(software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client.describeFleetUtilizationPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client
.describeFleetUtilizationPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeFleetUtilizationResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeFleetUtilizationIterable responses = client.describeFleetUtilizationPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeFleetUtilizationRequest.builder()
describeFleetUtilizationRequest - A Consumer that will call methods on DescribeFleetUtilizationInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameServerResponse describeGameServer(DescribeGameServerRequest describeGameServerRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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
describeGameServerRequest - 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.AwsServiceExceptiondefault DescribeGameServerResponse describeGameServer(Consumer<DescribeGameServerRequest.Builder> describeGameServerRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 via DescribeGameServerRequest.builder()
describeGameServerRequest - A Consumer that will call methods on DescribeGameServerInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeGameServerGroupResponse describeGameServerGroup(DescribeGameServerGroupRequest describeGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to 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
describeGameServerGroupRequest - 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.AwsServiceExceptiondefault DescribeGameServerGroupResponse describeGameServerGroup(Consumer<DescribeGameServerGroupRequest.Builder> describeGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to 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 via DescribeGameServerGroupRequest.builder()
describeGameServerGroupRequest - A Consumer that will call methods on DescribeGameServerGroupInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameServerInstancesResponse describeGameServerInstances(DescribeGameServerInstancesRequest describeGameServerInstancesRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a 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
describeGameServerInstancesRequest - 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.AwsServiceExceptiondefault DescribeGameServerInstancesResponse describeGameServerInstances(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a 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 via DescribeGameServerInstancesRequest.builder()
describeGameServerInstancesRequest - A Consumer that will call methods on DescribeGameServerInstancesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameServerInstancesIterable describeGameServerInstancesPaginator(DescribeGameServerInstancesRequest describeGameServerInstancesRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a 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 variant of
describeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesIterable responses = client.describeGameServerInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesIterable responses = client
.describeGameServerInstancesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesIterable responses = client.describeGameServerInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeGameServerInstancesRequest - 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.AwsServiceExceptiondefault DescribeGameServerInstancesIterable describeGameServerInstancesPaginator(Consumer<DescribeGameServerInstancesRequest.Builder> describeGameServerInstancesRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a 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 variant of
describeGameServerInstances(software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesIterable responses = client.describeGameServerInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesIterable responses = client
.describeGameServerInstancesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameServerInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameServerInstancesIterable responses = client.describeGameServerInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeGameServerInstancesRequest.builder()
describeGameServerInstancesRequest - A Consumer that will call methods on DescribeGameServerInstancesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionDetailsResponse describeGameSessionDetails(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
describeGameSessionDetailsRequest - 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.AwsServiceExceptiondefault DescribeGameSessionDetailsResponse describeGameSessionDetails(Consumer<DescribeGameSessionDetailsRequest.Builder> describeGameSessionDetailsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeGameSessionDetailsRequest.builder()
describeGameSessionDetailsRequest - A Consumer that will call methods on DescribeGameSessionDetailsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionDetailsIterable describeGameSessionDetailsPaginator(DescribeGameSessionDetailsRequest describeGameSessionDetailsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsIterable responses = client.describeGameSessionDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsIterable responses = client
.describeGameSessionDetailsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsIterable responses = client.describeGameSessionDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeGameSessionDetailsRequest - 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.AwsServiceExceptiondefault DescribeGameSessionDetailsIterable describeGameSessionDetailsPaginator(Consumer<DescribeGameSessionDetailsRequest.Builder> describeGameSessionDetailsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessionDetails(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsIterable responses = client.describeGameSessionDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsIterable responses = client
.describeGameSessionDetailsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionDetailsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionDetailsIterable responses = client.describeGameSessionDetailsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeGameSessionDetailsRequest.builder()
describeGameSessionDetailsRequest - A Consumer that will call methods on DescribeGameSessionDetailsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionPlacementResponse describeGameSessionPlacement(DescribeGameSessionPlacementRequest describeGameSessionPlacementRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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.
describeGameSessionPlacementRequest - 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.AwsServiceExceptiondefault DescribeGameSessionPlacementResponse describeGameSessionPlacement(Consumer<DescribeGameSessionPlacementRequest.Builder> describeGameSessionPlacementRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeGameSessionPlacementRequest.builder()
describeGameSessionPlacementRequest - A Consumer that will call methods on DescribeGameSessionPlacementInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionQueuesResponse describeGameSessionQueues() throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptiondescribeGameSessionQueues(DescribeGameSessionQueuesRequest),
AWS API Documentationdefault DescribeGameSessionQueuesResponse describeGameSessionQueues(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
describeGameSessionQueuesRequest - 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.AwsServiceExceptiondefault DescribeGameSessionQueuesResponse describeGameSessionQueues(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeGameSessionQueuesRequest.builder()
describeGameSessionQueuesRequest - A Consumer that will call methods on DescribeGameSessionQueuesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionQueuesIterable describeGameSessionQueuesPaginator() throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client.describeGameSessionQueuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client
.describeGameSessionQueuesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client.describeGameSessionQueuesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeGameSessionQueuesPaginator(DescribeGameSessionQueuesRequest),
AWS API Documentationdefault DescribeGameSessionQueuesIterable describeGameSessionQueuesPaginator(DescribeGameSessionQueuesRequest describeGameSessionQueuesRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client.describeGameSessionQueuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client
.describeGameSessionQueuesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client.describeGameSessionQueuesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeGameSessionQueuesRequest - 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.AwsServiceExceptiondefault DescribeGameSessionQueuesIterable describeGameSessionQueuesPaginator(Consumer<DescribeGameSessionQueuesRequest.Builder> describeGameSessionQueuesRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessionQueues(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client.describeGameSessionQueuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client
.describeGameSessionQueuesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionQueuesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionQueuesIterable responses = client.describeGameSessionQueuesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeGameSessionQueuesRequest.builder()
describeGameSessionQueuesRequest - A Consumer that will call methods on DescribeGameSessionQueuesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionsResponse describeGameSessions(DescribeGameSessionsRequest describeGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
describeGameSessionsRequest - 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.AwsServiceExceptiondefault DescribeGameSessionsResponse describeGameSessions(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeGameSessionsRequest.builder()
describeGameSessionsRequest - A Consumer that will call methods on DescribeGameSessionsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeGameSessionsIterable describeGameSessionsPaginator(DescribeGameSessionsRequest describeGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsIterable responses = client.describeGameSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsIterable responses = client
.describeGameSessionsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsIterable responses = client.describeGameSessionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeGameSessionsRequest - 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.AwsServiceExceptiondefault DescribeGameSessionsIterable describeGameSessionsPaginator(Consumer<DescribeGameSessionsRequest.Builder> describeGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeGameSessions(software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsIterable responses = client.describeGameSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsIterable responses = client
.describeGameSessionsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeGameSessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeGameSessionsIterable responses = client.describeGameSessionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeGameSessionsRequest.builder()
describeGameSessionsRequest - A Consumer that will call methods on DescribeGameSessionsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeInstancesResponse describeInstances(DescribeInstancesRequest describeInstancesRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance object is returned for each requested instance. Instances are not
returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
describeInstancesRequest - 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.AwsServiceExceptiondefault DescribeInstancesResponse describeInstances(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance object is returned for each requested instance. Instances are not
returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
This is a convenience which creates an instance of the DescribeInstancesRequest.Builder avoiding the need
to create one manually via DescribeInstancesRequest.builder()
describeInstancesRequest - A Consumer that will call methods on DescribeInstancesInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeInstancesIterable describeInstancesPaginator(DescribeInstancesRequest describeInstancesRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance object is returned for each requested instance. Instances are not
returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
This is a variant of
describeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesIterable responses = client.describeInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesIterable responses = client
.describeInstancesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesIterable responses = client.describeInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeInstancesRequest - 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.AwsServiceExceptiondefault DescribeInstancesIterable describeInstancesPaginator(Consumer<DescribeInstancesRequest.Builder> describeInstancesRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Retrieves information about a fleet's instances, including instance IDs, connection data, and status.
This operation can be used in the following ways:
To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.
To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.
To get information on a specific instance in a fleet, provide the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, an Instance object is returned for each requested instance. Instances are not
returned in any particular order.
Learn more
Remotely Access Fleet Instances
Related actions
This is a variant of
describeInstances(software.amazon.awssdk.services.gamelift.model.DescribeInstancesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesIterable responses = client.describeInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesIterable responses = client
.describeInstancesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeInstancesIterable responses = client.describeInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeInstancesRequest.builder()
describeInstancesRequest - A Consumer that will call methods on DescribeInstancesInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeMatchmakingResponse describeMatchmaking(DescribeMatchmakingRequest describeMatchmakingRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
describeMatchmakingRequest - 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.AwsServiceExceptiondefault DescribeMatchmakingResponse describeMatchmaking(Consumer<DescribeMatchmakingRequest.Builder> describeMatchmakingRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeMatchmakingRequest.builder()
describeMatchmakingRequest - A Consumer that will call methods on DescribeMatchmakingInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeMatchmakingConfigurationsResponse describeMatchmakingConfigurations() throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptiondescribeMatchmakingConfigurations(DescribeMatchmakingConfigurationsRequest),
AWS API Documentationdefault DescribeMatchmakingConfigurationsResponse describeMatchmakingConfigurations(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
describeMatchmakingConfigurationsRequest - 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.AwsServiceExceptiondefault DescribeMatchmakingConfigurationsResponse describeMatchmakingConfigurations(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeMatchmakingConfigurationsRequest.builder()
describeMatchmakingConfigurationsRequest - A Consumer that will call methods on DescribeMatchmakingConfigurationsInput.Builder to
create a request.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.AwsServiceExceptiondefault DescribeMatchmakingConfigurationsIterable describeMatchmakingConfigurationsPaginator() throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client.describeMatchmakingConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client
.describeMatchmakingConfigurationsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client.describeMatchmakingConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeMatchmakingConfigurationsPaginator(DescribeMatchmakingConfigurationsRequest),
AWS API Documentationdefault DescribeMatchmakingConfigurationsIterable describeMatchmakingConfigurationsPaginator(DescribeMatchmakingConfigurationsRequest describeMatchmakingConfigurationsRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client.describeMatchmakingConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client
.describeMatchmakingConfigurationsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client.describeMatchmakingConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeMatchmakingConfigurationsRequest - 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.AwsServiceExceptiondefault DescribeMatchmakingConfigurationsIterable describeMatchmakingConfigurationsPaginator(Consumer<DescribeMatchmakingConfigurationsRequest.Builder> describeMatchmakingConfigurationsRequest) throws InvalidRequestException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeMatchmakingConfigurations(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client.describeMatchmakingConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client
.describeMatchmakingConfigurationsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingConfigurationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingConfigurationsIterable responses = client.describeMatchmakingConfigurationsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeMatchmakingConfigurationsRequest.builder()
describeMatchmakingConfigurationsRequest - A Consumer that will call methods on DescribeMatchmakingConfigurationsInput.Builder to
create a request.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.AwsServiceExceptiondefault DescribeMatchmakingRuleSetsResponse describeMatchmakingRuleSets() throws InvalidRequestException, InternalServiceException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptiondescribeMatchmakingRuleSets(DescribeMatchmakingRuleSetsRequest),
AWS API Documentationdefault DescribeMatchmakingRuleSetsResponse describeMatchmakingRuleSets(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest) throws InvalidRequestException, InternalServiceException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
describeMatchmakingRuleSetsRequest - 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.AwsServiceExceptiondefault DescribeMatchmakingRuleSetsResponse describeMatchmakingRuleSets(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest) throws InvalidRequestException, InternalServiceException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeMatchmakingRuleSetsRequest.builder()
describeMatchmakingRuleSetsRequest - A Consumer that will call methods on DescribeMatchmakingRuleSetsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeMatchmakingRuleSetsIterable describeMatchmakingRuleSetsPaginator() throws InvalidRequestException, InternalServiceException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client.describeMatchmakingRuleSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client
.describeMatchmakingRuleSetsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client.describeMatchmakingRuleSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeMatchmakingRuleSetsPaginator(DescribeMatchmakingRuleSetsRequest),
AWS API Documentationdefault DescribeMatchmakingRuleSetsIterable describeMatchmakingRuleSetsPaginator(DescribeMatchmakingRuleSetsRequest describeMatchmakingRuleSetsRequest) throws InvalidRequestException, InternalServiceException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client.describeMatchmakingRuleSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client
.describeMatchmakingRuleSetsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client.describeMatchmakingRuleSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeMatchmakingRuleSetsRequest - 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.AwsServiceExceptiondefault DescribeMatchmakingRuleSetsIterable describeMatchmakingRuleSetsPaginator(Consumer<DescribeMatchmakingRuleSetsRequest.Builder> describeMatchmakingRuleSetsRequest) throws InvalidRequestException, InternalServiceException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeMatchmakingRuleSets(software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client.describeMatchmakingRuleSetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client
.describeMatchmakingRuleSetsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeMatchmakingRuleSetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeMatchmakingRuleSetsIterable responses = client.describeMatchmakingRuleSetsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeMatchmakingRuleSetsRequest.builder()
describeMatchmakingRuleSetsRequest - A Consumer that will call methods on DescribeMatchmakingRuleSetsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribePlayerSessionsResponse describePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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. 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
describePlayerSessionsRequest - 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.AwsServiceExceptiondefault DescribePlayerSessionsResponse describePlayerSessions(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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. 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 via DescribePlayerSessionsRequest.builder()
describePlayerSessionsRequest - A Consumer that will call methods on DescribePlayerSessionsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribePlayerSessionsIterable describePlayerSessionsPaginator(DescribePlayerSessionsRequest describePlayerSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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. 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 variant of
describePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsIterable responses = client.describePlayerSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsIterable responses = client
.describePlayerSessionsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsIterable responses = client.describePlayerSessionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describePlayerSessionsRequest - 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.AwsServiceExceptiondefault DescribePlayerSessionsIterable describePlayerSessionsPaginator(Consumer<DescribePlayerSessionsRequest.Builder> describePlayerSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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. 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 variant of
describePlayerSessions(software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsIterable responses = client.describePlayerSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsIterable responses = client
.describePlayerSessionsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribePlayerSessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribePlayerSessionsIterable responses = client.describePlayerSessionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribePlayerSessionsRequest.builder()
describePlayerSessionsRequest - A Consumer that will call methods on DescribePlayerSessionsInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeRuntimeConfigurationResponse describeRuntimeConfiguration(DescribeRuntimeConfigurationRequest describeRuntimeConfigurationRequest) throws UnauthorizedException, NotFoundException, InternalServiceException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.
To get the runtime configuration that is currently in forces 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
describeRuntimeConfigurationRequest - 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.AwsServiceExceptiondefault DescribeRuntimeConfigurationResponse describeRuntimeConfiguration(Consumer<DescribeRuntimeConfigurationRequest.Builder> describeRuntimeConfigurationRequest) throws UnauthorizedException, NotFoundException, InternalServiceException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.
To get the runtime configuration that is currently in forces 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
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 via DescribeRuntimeConfigurationRequest.builder()
describeRuntimeConfigurationRequest - A Consumer that will call methods on DescribeRuntimeConfigurationInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeScalingPoliciesResponse describeScalingPolicies(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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.
describeScalingPoliciesRequest - 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.AwsServiceExceptiondefault DescribeScalingPoliciesResponse describeScalingPolicies(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeScalingPoliciesRequest.builder()
describeScalingPoliciesRequest - A Consumer that will call methods on DescribeScalingPoliciesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeScalingPoliciesIterable describeScalingPoliciesPaginator(DescribeScalingPoliciesRequest describeScalingPoliciesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesIterable responses = client
.describeScalingPoliciesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeScalingPoliciesRequest - 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.AwsServiceExceptiondefault DescribeScalingPoliciesIterable describeScalingPoliciesPaginator(Consumer<DescribeScalingPoliciesRequest.Builder> describeScalingPoliciesRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 variant of
describeScalingPolicies(software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesIterable responses = client
.describeScalingPoliciesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.DescribeScalingPoliciesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.DescribeScalingPoliciesIterable responses = client.describeScalingPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via DescribeScalingPoliciesRequest.builder()
describeScalingPoliciesRequest - A Consumer that will call methods on DescribeScalingPoliciesInput.Builder to create a
request.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.AwsServiceExceptiondefault DescribeScriptResponse describeScript(DescribeScriptRequest describeScriptRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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
describeScriptRequest - 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.AwsServiceExceptiondefault DescribeScriptResponse describeScript(Consumer<DescribeScriptRequest.Builder> describeScriptRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeScriptRequest.builder()
describeScriptRequest - A Consumer that will call methods on DescribeScriptInput.Builder to create a request.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.AwsServiceExceptiondefault DescribeVpcPeeringAuthorizationsResponse describeVpcPeeringAuthorizations() throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptiondescribeVpcPeeringAuthorizations(DescribeVpcPeeringAuthorizationsRequest),
AWS API Documentationdefault DescribeVpcPeeringAuthorizationsResponse describeVpcPeeringAuthorizations(DescribeVpcPeeringAuthorizationsRequest describeVpcPeeringAuthorizationsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
describeVpcPeeringAuthorizationsRequest - 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.AwsServiceExceptiondefault DescribeVpcPeeringAuthorizationsResponse describeVpcPeeringAuthorizations(Consumer<DescribeVpcPeeringAuthorizationsRequest.Builder> describeVpcPeeringAuthorizationsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeVpcPeeringAuthorizationsRequest.builder()
describeVpcPeeringAuthorizationsRequest - A Consumer that will call methods on DescribeVpcPeeringAuthorizationsInput.Builder to
create a request.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.AwsServiceExceptiondefault DescribeVpcPeeringConnectionsResponse describeVpcPeeringConnections() throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptiondescribeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest),
AWS API Documentationdefault DescribeVpcPeeringConnectionsResponse describeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest describeVpcPeeringConnectionsRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
describeVpcPeeringConnectionsRequest - 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.AwsServiceExceptiondefault DescribeVpcPeeringConnectionsResponse describeVpcPeeringConnections(Consumer<DescribeVpcPeeringConnectionsRequest.Builder> describeVpcPeeringConnectionsRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via DescribeVpcPeeringConnectionsRequest.builder()
describeVpcPeeringConnectionsRequest - A Consumer that will call methods on DescribeVpcPeeringConnectionsInput.Builder to create
a request.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.AwsServiceExceptiondefault GetComputeAccessResponse getComputeAccess(GetComputeAccessRequest getComputeAccessRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a
Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop
client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an
SSH client. The private key must be saved in the proper format to a .pem file before using. If
you're making this request using the CLI, saving the secret can be handled as part of the
GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.
Learn more
getComputeAccessRequest - 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.AwsServiceExceptiondefault GetComputeAccessResponse getComputeAccess(Consumer<GetComputeAccessRequest.Builder> getComputeAccessRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a
Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop
client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an
SSH client. The private key must be saved in the proper format to a .pem file before using. If
you're making this request using the CLI, saving the secret can be handled as part of the
GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.
Learn more
Remotely Access Fleet Instances
This is a convenience which creates an instance of the GetComputeAccessRequest.Builder avoiding the need
to create one manually via GetComputeAccessRequest.builder()
getComputeAccessRequest - A Consumer that will call methods on GetComputeAccessInput.Builder to create a request.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.AwsServiceExceptiondefault GetComputeAuthTokenResponse getComputeAuthToken(GetComputeAuthTokenRequest getComputeAuthTokenRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Requests an authorization token from GameLift. The authorization token is used by your game server to authenticate with GameLift. Each authentication token has an expiration token. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.
getComputeAuthTokenRequest - 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.AwsServiceExceptiondefault GetComputeAuthTokenResponse getComputeAuthToken(Consumer<GetComputeAuthTokenRequest.Builder> getComputeAuthTokenRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Requests an authorization token from GameLift. The authorization token is used by your game server to authenticate with GameLift. Each authentication token has an expiration token. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.
This is a convenience which creates an instance of the GetComputeAuthTokenRequest.Builder avoiding the
need to create one manually via GetComputeAuthTokenRequest.builder()
getComputeAuthTokenRequest - A Consumer that will call methods on GetComputeAuthTokenInput.Builder to create a request.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.AwsServiceExceptiondefault GetGameSessionLogUrlResponse getGameSessionLogUrl(GetGameSessionLogUrlRequest getGameSessionLogUrlRequest) throws InternalServiceException, NotFoundException, UnauthorizedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, 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.
getGameSessionLogUrlRequest - 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.AwsServiceExceptiondefault GetGameSessionLogUrlResponse getGameSessionLogUrl(Consumer<GetGameSessionLogUrlRequest.Builder> getGameSessionLogUrlRequest) throws InternalServiceException, NotFoundException, UnauthorizedException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, 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 via GetGameSessionLogUrlRequest.builder()
getGameSessionLogUrlRequest - A Consumer that will call methods on GetGameSessionLogUrlInput.Builder to create a
request.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.AwsServiceExceptiondefault GetInstanceAccessResponse getInstanceAccess(GetInstanceAccessRequest getInstanceAccessRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a
Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop
client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an
SSH client. The private key must be saved in the proper format to a .pem file before using. If
you're making this request using the CLI, saving the secret can be handled as part of the
GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.
Learn more
Remotely Access Fleet Instances
Related actions
getInstanceAccessRequest - 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.AwsServiceExceptiondefault GetInstanceAccessResponse getInstanceAccess(Consumer<GetInstanceAccessRequest.Builder> getInstanceAccessRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.
To remotely access an instance, you need credentials that match the operating system of the instance. For a
Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop
client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an
SSH client. The private key must be saved in the proper format to a .pem file before using. If
you're making this request using the CLI, saving the secret can be handled as part of the
GetInstanceAccess request, as shown in one of the examples for this operation.
To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances.
Learn more
Remotely Access Fleet Instances
Related actions
This is a convenience which creates an instance of the GetInstanceAccessRequest.Builder avoiding the need
to create one manually via GetInstanceAccessRequest.builder()
getInstanceAccessRequest - A Consumer that will call methods on GetInstanceAccessInput.Builder to create a request.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.AwsServiceExceptiondefault ListAliasesResponse listAliases() throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptionlistAliases(ListAliasesRequest),
AWS API
Documentationdefault ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
listAliasesRequest - 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.AwsServiceExceptiondefault ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesInput.Builder to create a request.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.AwsServiceExceptiondefault ListAliasesIterable listAliasesPaginator() throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptionlistAliasesPaginator(ListAliasesRequest),
AWS API
Documentationdefault ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listAliasesRequest - 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.AwsServiceExceptiondefault ListAliasesIterable listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listAliases(software.amazon.awssdk.services.gamelift.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListAliasesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListAliasesRequest.builder()
listAliasesRequest - A Consumer that will call methods on ListAliasesInput.Builder to create a request.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.AwsServiceExceptiondefault ListBuildsResponse listBuilds() throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
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.AwsServiceExceptionlistBuilds(ListBuildsRequest),
AWS API
Documentationdefault ListBuildsResponse listBuilds(ListBuildsRequest listBuildsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
listBuildsRequest - 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.AwsServiceExceptiondefault ListBuildsResponse listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via ListBuildsRequest.builder()
listBuildsRequest - A Consumer that will call methods on ListBuildsInput.Builder to create a request.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.AwsServiceExceptiondefault ListBuildsIterable listBuildsPaginator() throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListBuildsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptionlistBuildsPaginator(ListBuildsRequest),
AWS API
Documentationdefault ListBuildsIterable listBuildsPaginator(ListBuildsRequest listBuildsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListBuildsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listBuildsRequest - 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.AwsServiceExceptiondefault ListBuildsIterable listBuildsPaginator(Consumer<ListBuildsRequest.Builder> listBuildsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listBuilds(software.amazon.awssdk.services.gamelift.model.ListBuildsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListBuildsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListBuildsIterable responses = client.listBuildsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListBuildsRequest.builder()
listBuildsRequest - A Consumer that will call methods on ListBuildsInput.Builder to create a request.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.AwsServiceExceptiondefault ListComputeResponse listCompute(ListComputeRequest listComputeRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.
listComputeRequest - 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.AwsServiceExceptiondefault ListComputeResponse listCompute(Consumer<ListComputeRequest.Builder> listComputeRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.
This is a convenience which creates an instance of the ListComputeRequest.Builder avoiding the need to
create one manually via ListComputeRequest.builder()
listComputeRequest - A Consumer that will call methods on ListComputeInput.Builder to create a request.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.AwsServiceExceptiondefault ListComputeIterable listComputePaginator(ListComputeRequest listComputeRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.
This is a variant of listCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListComputeIterable responses = client.listComputePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListComputeIterable responses = client.listComputePaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListComputeResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListComputeIterable responses = client.listComputePaginator(request);
responses.iterator().forEachRemaining(....);
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.
listComputeRequest - 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.AwsServiceExceptiondefault ListComputeIterable listComputePaginator(Consumer<ListComputeRequest.Builder> listComputeRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.
This is a variant of listCompute(software.amazon.awssdk.services.gamelift.model.ListComputeRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListComputeIterable responses = client.listComputePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListComputeIterable responses = client.listComputePaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListComputeResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListComputeIterable responses = client.listComputePaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListComputeRequest.builder()
listComputeRequest - A Consumer that will call methods on ListComputeInput.Builder to create a request.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.AwsServiceExceptiondefault ListFleetsResponse listFleets() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. 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.
This operation can be used 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 custom 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.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
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.AwsServiceExceptionlistFleets(ListFleetsRequest),
AWS API
Documentationdefault ListFleetsResponse listFleets(ListFleetsRequest listFleetsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. 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.
This operation can be used 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 custom 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.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
listFleetsRequest - 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.AwsServiceExceptiondefault ListFleetsResponse listFleets(Consumer<ListFleetsRequest.Builder> listFleetsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. 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.
This operation can be used 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 custom 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.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
This is a convenience which creates an instance of the ListFleetsRequest.Builder avoiding the need to
create one manually via ListFleetsRequest.builder()
listFleetsRequest - A Consumer that will call methods on ListFleetsInput.Builder to create a request.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.AwsServiceExceptiondefault ListFleetsIterable listFleetsPaginator() throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. 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.
This operation can be used 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 custom 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.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
This is a variant of listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListFleetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptionlistFleetsPaginator(ListFleetsRequest),
AWS API
Documentationdefault ListFleetsIterable listFleetsPaginator(ListFleetsRequest listFleetsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. 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.
This operation can be used 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 custom 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.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
This is a variant of listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListFleetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listFleetsRequest - 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.AwsServiceExceptiondefault ListFleetsIterable listFleetsPaginator(Consumer<ListFleetsRequest.Builder> listFleetsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. 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.
This operation can be used 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 custom 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.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.
Fleet resources are not listed in a particular order.
Learn more
This is a variant of listFleets(software.amazon.awssdk.services.gamelift.model.ListFleetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListFleetsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListFleetsIterable responses = client.listFleetsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListFleetsRequest.builder()
listFleetsRequest - A Consumer that will call methods on ListFleetsInput.Builder to create a request.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.AwsServiceExceptiondefault ListGameServerGroupsResponse listGameServerGroups(ListGameServerGroupsRequest listGameServerGroupsRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists a game server groups.
listGameServerGroupsRequest - 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.AwsServiceExceptiondefault ListGameServerGroupsResponse listGameServerGroups(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists a game server groups.
This is a convenience which creates an instance of the ListGameServerGroupsRequest.Builder avoiding the
need to create one manually via ListGameServerGroupsRequest.builder()
listGameServerGroupsRequest - A Consumer that will call methods on ListGameServerGroupsInput.Builder to create a
request.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.AwsServiceExceptiondefault ListGameServerGroupsIterable listGameServerGroupsPaginator(ListGameServerGroupsRequest listGameServerGroupsRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists a game server groups.
This is a variant of
listGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsIterable responses = client.listGameServerGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsIterable responses = client
.listGameServerGroupsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsIterable responses = client.listGameServerGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listGameServerGroupsRequest - 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.AwsServiceExceptiondefault ListGameServerGroupsIterable listGameServerGroupsPaginator(Consumer<ListGameServerGroupsRequest.Builder> listGameServerGroupsRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists a game server groups.
This is a variant of
listGameServerGroups(software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsIterable responses = client.listGameServerGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsIterable responses = client
.listGameServerGroupsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListGameServerGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListGameServerGroupsIterable responses = client.listGameServerGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListGameServerGroupsRequest.builder()
listGameServerGroupsRequest - A Consumer that will call methods on ListGameServerGroupsInput.Builder to create a
request.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.AwsServiceExceptiondefault ListGameServersResponse listGameServers(ListGameServersRequest listGameServersRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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
listGameServersRequest - 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.AwsServiceExceptiondefault ListGameServersResponse listGameServers(Consumer<ListGameServersRequest.Builder> listGameServersRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 via ListGameServersRequest.builder()
listGameServersRequest - A Consumer that will call methods on ListGameServersInput.Builder to create a request.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.AwsServiceExceptiondefault ListGameServersIterable listGameServersPaginator(ListGameServersRequest listGameServersRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 variant of
listGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListGameServersIterable responses = client.listGameServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListGameServersIterable responses = client
.listGameServersPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListGameServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListGameServersIterable responses = client.listGameServersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listGameServersRequest - 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.AwsServiceExceptiondefault ListGameServersIterable listGameServersPaginator(Consumer<ListGameServersRequest.Builder> listGameServersRequest) throws InvalidRequestException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 variant of
listGameServers(software.amazon.awssdk.services.gamelift.model.ListGameServersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListGameServersIterable responses = client.listGameServersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListGameServersIterable responses = client
.listGameServersPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListGameServersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListGameServersIterable responses = client.listGameServersPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListGameServersRequest.builder()
listGameServersRequest - A Consumer that will call methods on ListGameServersInput.Builder to create a request.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.AwsServiceExceptiondefault ListLocationsResponse listLocations(ListLocationsRequest listLocationsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists all custom and Amazon Web Services locations.
listLocationsRequest - 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.AwsServiceExceptiondefault ListLocationsResponse listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via ListLocationsRequest.builder()
listLocationsRequest - A Consumer that will call methods on ListLocationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListLocationsIterable listLocationsPaginator(ListLocationsRequest listLocationsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists all custom and Amazon Web Services locations.
This is a variant of listLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListLocationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listLocationsRequest - 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.AwsServiceExceptiondefault ListLocationsIterable listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Lists all custom and Amazon Web Services locations.
This is a variant of listLocations(software.amazon.awssdk.services.gamelift.model.ListLocationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListLocationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListLocationsRequest.builder()
listLocationsRequest - A Consumer that will call methods on ListLocationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListScriptsResponse listScripts(ListScriptsRequest listScriptsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
listScriptsRequest - 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.AwsServiceExceptiondefault ListScriptsResponse listScripts(Consumer<ListScriptsRequest.Builder> listScriptsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via ListScriptsRequest.builder()
listScriptsRequest - A Consumer that will call methods on ListScriptsInput.Builder to create a request.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.AwsServiceExceptiondefault ListScriptsIterable listScriptsPaginator(ListScriptsRequest listScriptsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListScriptsIterable responses = client.listScriptsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListScriptsIterable responses = client.listScriptsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListScriptsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListScriptsIterable responses = client.listScriptsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listScriptsRequest - 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.AwsServiceExceptiondefault ListScriptsIterable listScriptsPaginator(Consumer<ListScriptsRequest.Builder> listScriptsRequest) throws UnauthorizedException, InvalidRequestException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 variant of listScripts(software.amazon.awssdk.services.gamelift.model.ListScriptsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.ListScriptsIterable responses = client.listScriptsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.ListScriptsIterable responses = client.listScriptsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.ListScriptsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.ListScriptsIterable responses = client.listScriptsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListScriptsRequest.builder()
listScriptsRequest - A Consumer that will call methods on ListScriptsInput.Builder to create a request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
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
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault PutScalingPolicyResponse putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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.
putScalingPolicyRequest - 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.AwsServiceExceptiondefault PutScalingPolicyResponse putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, AwsServiceException, SdkClientException, GameLiftException
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 via PutScalingPolicyRequest.builder()
putScalingPolicyRequest - A Consumer that will call methods on PutScalingPolicyInput.Builder to create a request.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.AwsServiceExceptiondefault RegisterComputeResponse registerCompute(RegisterComputeRequest registerComputeRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.
Learn more
registerComputeRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GameLiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterComputeResponse registerCompute(Consumer<RegisterComputeRequest.Builder> registerComputeRequest) throws UnauthorizedException, InvalidRequestException, ConflictException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Registers your compute resources in a fleet you previously created. After you register a compute to your fleet, you can monitor and manage your compute using GameLift. The operation returns the compute resource containing SDK endpoint you can use to connect your game server to GameLift.
Learn more
This is a convenience which creates an instance of the RegisterComputeRequest.Builder avoiding the need
to create one manually via RegisterComputeRequest.builder()
registerComputeRequest - A Consumer that will call methods on RegisterComputeInput.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GameLiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterGameServerResponse registerGameServer(RegisterGameServerRequest registerGameServerRequest) throws InvalidRequestException, ConflictException, UnauthorizedException, LimitExceededException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies 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 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
registerGameServerRequest - 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.AwsServiceExceptiondefault RegisterGameServerResponse registerGameServer(Consumer<RegisterGameServerRequest.Builder> registerGameServerRequest) throws InvalidRequestException, ConflictException, UnauthorizedException, LimitExceededException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Creates a new game server resource and notifies 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 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 via RegisterGameServerRequest.builder()
registerGameServerRequest - A Consumer that will call methods on RegisterGameServerInput.Builder to create a request.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.AwsServiceExceptiondefault RequestUploadCredentialsResponse requestUploadCredentials(RequestUploadCredentialsRequest requestUploadCredentialsRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 GameSession.
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
requestUploadCredentialsRequest - 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.AwsServiceExceptiondefault RequestUploadCredentialsResponse requestUploadCredentials(Consumer<RequestUploadCredentialsRequest.Builder> requestUploadCredentialsRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 GameSession.
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 via RequestUploadCredentialsRequest.builder()
requestUploadCredentialsRequest - A Consumer that will call methods on RequestUploadCredentialsInput.Builder to create a
request.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.AwsServiceExceptiondefault ResolveAliasResponse resolveAlias(ResolveAliasRequest resolveAliasRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, TerminalRoutingStrategyException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
resolveAliasRequest - 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.AwsServiceExceptiondefault ResolveAliasResponse resolveAlias(Consumer<ResolveAliasRequest.Builder> resolveAliasRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, TerminalRoutingStrategyException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Retrieves the fleet ID that an alias is currently pointing to.
Related actions
This is a convenience which creates an instance of the ResolveAliasRequest.Builder avoiding the need to
create one manually via ResolveAliasRequest.builder()
resolveAliasRequest - A Consumer that will call methods on ResolveAliasInput.Builder to create a request.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.AwsServiceExceptiondefault ResumeGameServerGroupResponse resumeGameServerGroup(ResumeGameServerGroupRequest resumeGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 in
SuspendedActions.
Learn more
resumeGameServerGroupRequest - 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.AwsServiceExceptiondefault ResumeGameServerGroupResponse resumeGameServerGroup(Consumer<ResumeGameServerGroupRequest.Builder> resumeGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 in
SuspendedActions.
Learn more
This is a convenience which creates an instance of the ResumeGameServerGroupRequest.Builder avoiding the
need to create one manually via ResumeGameServerGroupRequest.builder()
resumeGameServerGroupRequest - A Consumer that will call methods on ResumeGameServerGroupInput.Builder to create a
request.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.AwsServiceExceptiondefault SearchGameSessionsResponse searchGameSessions(SearchGameSessionsRequest searchGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 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 game
session status with DescribeGameSessions should only be used for games in development with low game
session usage.
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 in ACTIVE status only. To retrieve information on game sessions
in other statuses, use DescribeGameSessions .
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId
or GameSessionArn value.
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter.
GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a
string to search the data values for. For example, to search for game sessions with custom data containing the
key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl".
All custom data values are searched as strings.
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 and hasAvailablePlayerSessions change quickly as
players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh
search results often, and handle sessions that fill up before a player can join.
searchGameSessionsRequest - 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.AwsServiceExceptiondefault SearchGameSessionsResponse searchGameSessions(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 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 game
session status with DescribeGameSessions should only be used for games in development with low game
session usage.
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 in ACTIVE status only. To retrieve information on game sessions
in other statuses, use DescribeGameSessions .
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId
or GameSessionArn value.
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter.
GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a
string to search the data values for. For example, to search for game sessions with custom data containing the
key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl".
All custom data values are searched as strings.
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 and hasAvailablePlayerSessions change quickly as
players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh
search results often, and handle sessions that fill up before a player can join.
This is a convenience which creates an instance of the SearchGameSessionsRequest.Builder avoiding the
need to create one manually via SearchGameSessionsRequest.builder()
searchGameSessionsRequest - A Consumer that will call methods on SearchGameSessionsInput.Builder to create a request.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.AwsServiceExceptiondefault SearchGameSessionsIterable searchGameSessionsPaginator(SearchGameSessionsRequest searchGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 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 game
session status with DescribeGameSessions should only be used for games in development with low game
session usage.
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 in ACTIVE status only. To retrieve information on game sessions
in other statuses, use DescribeGameSessions .
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId
or GameSessionArn value.
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter.
GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a
string to search the data values for. For example, to search for game sessions with custom data containing the
key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl".
All custom data values are searched as strings.
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 and hasAvailablePlayerSessions change quickly as
players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh
search results often, and handle sessions that fill up before a player can join.
This is a variant of
searchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsIterable responses = client.searchGameSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsIterable responses = client
.searchGameSessionsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.SearchGameSessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsIterable responses = client.searchGameSessionsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
searchGameSessionsRequest - 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.AwsServiceExceptiondefault SearchGameSessionsIterable searchGameSessionsPaginator(Consumer<SearchGameSessionsRequest.Builder> searchGameSessionsRequest) throws InternalServiceException, NotFoundException, InvalidRequestException, UnauthorizedException, TerminalRoutingStrategyException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 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 game
session status with DescribeGameSessions should only be used for games in development with low game
session usage.
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 in ACTIVE status only. To retrieve information on game sessions
in other statuses, use DescribeGameSessions .
You can search or sort by the following game session attributes:
gameSessionId -- A unique identifier for the game session. You can use either a GameSessionId
or GameSessionArn value.
gameSessionName -- Name assigned to a game session. Game session names do not need to be unique to a game session.
gameSessionProperties -- Custom data defined in a game session's GameProperty parameter.
GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a
string to search the data values for. For example, to search for game sessions with custom data containing the
key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl".
All custom data values are searched as strings.
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 and hasAvailablePlayerSessions change quickly as
players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh
search results often, and handle sessions that fill up before a player can join.
This is a variant of
searchGameSessions(software.amazon.awssdk.services.gamelift.model.SearchGameSessionsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsIterable responses = client.searchGameSessionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsIterable responses = client
.searchGameSessionsPaginator(request);
for (software.amazon.awssdk.services.gamelift.model.SearchGameSessionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.gamelift.paginators.SearchGameSessionsIterable responses = client.searchGameSessionsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via SearchGameSessionsRequest.builder()
searchGameSessionsRequest - A Consumer that will call methods on SearchGameSessionsInput.Builder to create a request.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.AwsServiceExceptiondefault StartFleetActionsResponse startFleetActions(StartFleetActionsRequest startFleetActionsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, 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
startFleetActionsRequest - 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.AwsServiceExceptiondefault StartFleetActionsResponse startFleetActions(Consumer<StartFleetActionsRequest.Builder> startFleetActionsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, 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
This is a convenience which creates an instance of the StartFleetActionsRequest.Builder avoiding the need
to create one manually via StartFleetActionsRequest.builder()
startFleetActionsRequest - A Consumer that will call methods on StartFleetActionsInput.Builder to create a request.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.AwsServiceExceptiondefault StartGameSessionPlacementResponse startGameSessionPlacement(StartGameSessionPlacementRequest startGameSessionPlacementRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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.
startGameSessionPlacementRequest - 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.AwsServiceExceptiondefault StartGameSessionPlacementResponse startGameSessionPlacement(Consumer<StartGameSessionPlacementRequest.Builder> startGameSessionPlacementRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 via StartGameSessionPlacementRequest.builder()
startGameSessionPlacementRequest - A Consumer that will call methods on StartGameSessionPlacementInput.Builder to create a
request.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.AwsServiceExceptiondefault StartMatchBackfillResponse startMatchBackfill(StartMatchBackfillRequest startMatchBackfillRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 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 the GameSession 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)
startMatchBackfillRequest - 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.AwsServiceExceptiondefault StartMatchBackfillResponse startMatchBackfill(Consumer<StartMatchBackfillRequest.Builder> startMatchBackfillRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 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 the GameSession 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)
This is a convenience which creates an instance of the StartMatchBackfillRequest.Builder avoiding the
need to create one manually via StartMatchBackfillRequest.builder()
startMatchBackfillRequest - A Consumer that will call methods on StartMatchBackfillInput.Builder to create a request.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.AwsServiceExceptiondefault StartMatchmakingResponse startMatchmaking(StartMatchmakingRequest startMatchmakingRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers 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
startMatchmakingRequest - 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.AwsServiceExceptiondefault StartMatchmakingResponse startMatchmaking(Consumer<StartMatchmakingRequest.Builder> startMatchmakingRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers 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
This is a convenience which creates an instance of the StartMatchmakingRequest.Builder avoiding the need
to create one manually via StartMatchmakingRequest.builder()
startMatchmakingRequest - A Consumer that will call methods on StartMatchmakingInput.Builder to create a request.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.AwsServiceExceptiondefault StopFleetActionsResponse stopFleetActions(StopFleetActionsRequest stopFleetActionsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.
Learn more
stopFleetActionsRequest - 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.AwsServiceExceptiondefault StopFleetActionsResponse stopFleetActions(Consumer<StopFleetActionsRequest.Builder> stopFleetActionsRequest) throws InternalServiceException, InvalidRequestException, UnauthorizedException, NotFoundException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity.
Learn more
This is a convenience which creates an instance of the StopFleetActionsRequest.Builder avoiding the need
to create one manually via StopFleetActionsRequest.builder()
stopFleetActionsRequest - A Consumer that will call methods on StopFleetActionsInput.Builder to create a request.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.AwsServiceExceptiondefault StopGameSessionPlacementResponse stopGameSessionPlacement(StopGameSessionPlacementRequest stopGameSessionPlacementRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 to CANCELLED status.
stopGameSessionPlacementRequest - 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.AwsServiceExceptiondefault StopGameSessionPlacementResponse stopGameSessionPlacement(Consumer<StopGameSessionPlacementRequest.Builder> stopGameSessionPlacementRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 to CANCELLED status.
This is a convenience which creates an instance of the StopGameSessionPlacementRequest.Builder avoiding
the need to create one manually via StopGameSessionPlacementRequest.builder()
stopGameSessionPlacementRequest - A Consumer that will call methods on StopGameSessionPlacementInput.Builder to create a
request.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.AwsServiceExceptiondefault StopMatchmakingResponse stopMatchmaking(StopMatchmakingRequest stopMatchmakingRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
stopMatchmakingRequest - 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.AwsServiceExceptiondefault StopMatchmakingResponse stopMatchmaking(Consumer<StopMatchmakingRequest.Builder> stopMatchmakingRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via StopMatchmakingRequest.builder()
stopMatchmakingRequest - A Consumer that will call methods on StopMatchmakingInput.Builder to create a request.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.AwsServiceExceptiondefault SuspendGameServerGroupResponse suspendGameServerGroup(SuspendGameServerGroupRequest suspendGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 in
SuspendedActions.
Learn more
suspendGameServerGroupRequest - 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.AwsServiceExceptiondefault SuspendGameServerGroupResponse suspendGameServerGroup(Consumer<SuspendGameServerGroupRequest.Builder> suspendGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the 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 in
SuspendedActions.
Learn more
This is a convenience which creates an instance of the SuspendGameServerGroupRequest.Builder avoiding the
need to create one manually via SuspendGameServerGroupRequest.builder()
suspendGameServerGroupRequest - A Consumer that will call methods on SuspendGameServerGroupInput.Builder to create a
request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
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 specified resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
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 specified 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
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 be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.
Learn more
Tagging Amazon Web Services Resources in the Amazon Web Services General Reference
Amazon Web Services Tagging Strategies
Related actions
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws NotFoundException, InvalidRequestException, TaggingFailedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize Amazon Web Services resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:
Build
Script
Fleet
Alias
GameSessionQueue
MatchmakingConfiguration
MatchmakingRuleSet
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 be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateAliasResponse updateAlias(UpdateAliasRequest updateAliasRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
updateAliasRequest - 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.AwsServiceExceptiondefault UpdateAliasResponse updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
Related actions
This is a convenience which creates an instance of the UpdateAliasRequest.Builder avoiding the need to
create one manually via UpdateAliasRequest.builder()
updateAliasRequest - A Consumer that will call methods on UpdateAliasInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateBuildResponse updateBuild(UpdateBuildRequest updateBuildRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
updateBuildRequest - 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.AwsServiceExceptiondefault UpdateBuildResponse updateBuild(Consumer<UpdateBuildRequest.Builder> updateBuildRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via UpdateBuildRequest.builder()
updateBuildRequest - A Consumer that will call methods on UpdateBuildInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateFleetAttributesResponse updateFleetAttributes(UpdateFleetAttributesRequest updateFleetAttributesRequest) throws NotFoundException, ConflictException, InvalidFleetStatusException, LimitExceededException, InternalServiceException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Updates a fleet's mutable attributes, including 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, an updated FleetAttributes object is returned.
Learn more
updateFleetAttributesRequest - 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.AwsServiceExceptiondefault UpdateFleetAttributesResponse updateFleetAttributes(Consumer<UpdateFleetAttributesRequest.Builder> updateFleetAttributesRequest) throws NotFoundException, ConflictException, InvalidFleetStatusException, LimitExceededException, InternalServiceException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Updates a fleet's mutable attributes, including 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, an updated FleetAttributes object is returned.
Learn more
This is a convenience which creates an instance of the UpdateFleetAttributesRequest.Builder avoiding the
need to create one manually via UpdateFleetAttributesRequest.builder()
updateFleetAttributesRequest - A Consumer that will call methods on UpdateFleetAttributesInput.Builder to create a
request.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.AwsServiceExceptiondefault UpdateFleetCapacityResponse updateFleetCapacity(UpdateFleetCapacityRequest updateFleetCapacityRequest) throws NotFoundException, ConflictException, LimitExceededException, InvalidFleetStatusException, InternalServiceException, InvalidRequestException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:
Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.
Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.
This operation can be used in the following ways:
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 in ACTIVE status.
To update capacity for a fleet's remote location, include the Location parameter set to the location
to be updated. The location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift
initiates steps to start new instances or terminate existing instances in the requested fleet location. This
continues until the location's active instance count matches the new desired instance count. You can track a
fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's
limit, the LimitExceeded exception occurs.
Learn more
updateFleetCapacityRequest - 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.AwsServiceExceptiondefault UpdateFleetCapacityResponse updateFleetCapacity(Consumer<UpdateFleetCapacityRequest.Builder> updateFleetCapacityRequest) throws NotFoundException, ConflictException, LimitExceededException, InvalidFleetStatusException, InternalServiceException, InvalidRequestException, UnauthorizedException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:
Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.
Desired capacity: Manually set the number of Amazon EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.
This operation can be used in the following ways:
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 in ACTIVE status.
To update capacity for a fleet's remote location, include the Location parameter set to the location
to be updated. The location must be in ACTIVE status.
If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift
initiates steps to start new instances or terminate existing instances in the requested fleet location. This
continues until the location's active instance count matches the new desired instance count. You can track a
fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's
limit, the LimitExceeded exception occurs.
Learn more
This is a convenience which creates an instance of the UpdateFleetCapacityRequest.Builder avoiding the
need to create one manually via UpdateFleetCapacityRequest.builder()
updateFleetCapacityRequest - A Consumer that will call methods on UpdateFleetCapacityInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateFleetPortSettingsResponse updateFleetPortSettings(UpdateFleetPortSettingsRequest updateFleetPortSettingsRequest) throws NotFoundException, ConflictException, InvalidFleetStatusException, LimitExceededException, InternalServiceException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances 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 in
InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.
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
updateFleetPortSettingsRequest - 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.AwsServiceExceptiondefault UpdateFleetPortSettingsResponse updateFleetPortSettings(Consumer<UpdateFleetPortSettingsRequest.Builder> updateFleetPortSettingsRequest) throws NotFoundException, ConflictException, InvalidFleetStatusException, LimitExceededException, InternalServiceException, InvalidRequestException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances 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 in
InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.
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
This is a convenience which creates an instance of the UpdateFleetPortSettingsRequest.Builder avoiding
the need to create one manually via UpdateFleetPortSettingsRequest.builder()
updateFleetPortSettingsRequest - A Consumer that will call methods on UpdateFleetPortSettingsInput.Builder to create a
request.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.AwsServiceExceptiondefault UpdateGameServerResponse updateGameServer(UpdateGameServerRequest updateGameServerRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help GameLift FleetIQ to 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, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.
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
updateGameServerRequest - 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.AwsServiceExceptiondefault UpdateGameServerResponse updateGameServer(Consumer<UpdateGameServerRequest.Builder> updateGameServerRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Updates information about a registered game server to help GameLift FleetIQ to 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, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.
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 via UpdateGameServerRequest.builder()
updateGameServerRequest - A Consumer that will call methods on UpdateGameServerInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateGameServerGroupResponse updateGameServerGroup(UpdateGameServerGroupRequest updateGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Updates 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 GameLift FleetIQ can continue to perform instance
balancing activity. If successful, a GameServerGroup object is returned.
Learn more
updateGameServerGroupRequest - 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.AwsServiceExceptiondefault UpdateGameServerGroupResponse updateGameServerGroup(Consumer<UpdateGameServerGroupRequest.Builder> updateGameServerGroupRequest) throws InvalidRequestException, NotFoundException, UnauthorizedException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
This operation is used with the GameLift FleetIQ solution and game server groups.
Updates 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 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 via UpdateGameServerGroupRequest.builder()
updateGameServerGroupRequest - A Consumer that will call methods on UpdateGameServerGroupInput.Builder to create a
request.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.AwsServiceExceptiondefault UpdateGameSessionResponse updateGameSession(UpdateGameSessionRequest updateGameSessionRequest) throws NotFoundException, ConflictException, InternalServiceException, UnauthorizedException, InvalidGameSessionStatusException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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.
updateGameSessionRequest - 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.AwsServiceExceptiondefault UpdateGameSessionResponse updateGameSession(Consumer<UpdateGameSessionRequest.Builder> updateGameSessionRequest) throws NotFoundException, ConflictException, InternalServiceException, UnauthorizedException, InvalidGameSessionStatusException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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 via UpdateGameSessionRequest.builder()
updateGameSessionRequest - A Consumer that will call methods on UpdateGameSessionInput.Builder to create a request.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.AwsServiceExceptiondefault UpdateGameSessionQueueResponse updateGameSessionQueue(UpdateGameSessionQueueRequest updateGameSessionQueueRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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
updateGameSessionQueueRequest - 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.AwsServiceExceptiondefault UpdateGameSessionQueueResponse updateGameSessionQueue(Consumer<UpdateGameSessionQueueRequest.Builder> updateGameSessionQueueRequest) throws InternalServiceException, InvalidRequestException, NotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, GameLiftException
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 via UpdateGameSessionQueueRequest.builder()
updateGameSessionQueueRequest - A Consumer that will call methods on UpdateGameSessionQueueInput.Builder to create a
request.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.AwsServiceExceptiondefault UpdateMatchmakingConfigurationResponse updateMatchmakingConfiguration(UpdateMatchmakingConfigurationRequest updateMatchmakingConfigurationRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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
updateMatchmakingConfigurationRequest - 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.AwsServiceExceptiondefault UpdateMatchmakingConfigurationResponse updateMatchmakingConfiguration(Consumer<UpdateMatchmakingConfigurationRequest.Builder> updateMatchmakingConfigurationRequest) throws InvalidRequestException, NotFoundException, InternalServiceException, UnsupportedRegionException, AwsServiceException, SdkClientException, GameLiftException
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 via UpdateMatchmakingConfigurationRequest.builder()
updateMatchmakingConfigurationRequest - A Consumer that will call methods on UpdateMatchmakingConfigurationInput.Builder to create
a request.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.AwsServiceExceptiondefault UpdateRuntimeConfigurationResponse updateRuntimeConfiguration(UpdateRuntimeConfigurationRequest updateRuntimeConfigurationRequest) throws UnauthorizedException, NotFoundException, InternalServiceException, InvalidRequestException, InvalidFleetStatusException, AwsServiceException, SdkClientException, GameLiftException
Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server
processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the
fleet is created; it does not need to be in 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. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
updateRuntimeConfigurationRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GameLiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRuntimeConfigurationResponse updateRuntimeConfiguration(Consumer<UpdateRuntimeConfigurationRequest.Builder> updateRuntimeConfigurationRequest) throws UnauthorizedException, NotFoundException, InternalServiceException, InvalidRequestException, InvalidFleetStatusException, AwsServiceException, SdkClientException, GameLiftException
Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server
processes on all instances in the fleet. You can update a fleet's runtime configuration at any time after the
fleet is created; it does not need to be in 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. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
This is a convenience which creates an instance of the UpdateRuntimeConfigurationRequest.Builder avoiding
the need to create one manually via UpdateRuntimeConfigurationRequest.builder()
updateRuntimeConfigurationRequest - A Consumer that will call methods on UpdateRuntimeConfigurationInput.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.GameLiftException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateScriptResponse updateScript(UpdateScriptRequest updateScriptRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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
updateScriptRequest - 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.AwsServiceExceptiondefault UpdateScriptResponse updateScript(Consumer<UpdateScriptRequest.Builder> updateScriptRequest) throws UnauthorizedException, InvalidRequestException, NotFoundException, InternalServiceException, AwsServiceException, SdkClientException, GameLiftException
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 via UpdateScriptRequest.builder()
updateScriptRequest - A Consumer that will call methods on UpdateScriptInput.Builder to create a request.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.AwsServiceExceptiondefault ValidateMatchmakingRuleSetResponse validateMatchmakingRuleSet(ValidateMatchmakingRuleSetRequest validateMatchmakingRuleSetRequest) throws InternalServiceException, UnsupportedRegionException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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
validateMatchmakingRuleSetRequest - 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.AwsServiceExceptiondefault ValidateMatchmakingRuleSetResponse validateMatchmakingRuleSet(Consumer<ValidateMatchmakingRuleSetRequest.Builder> validateMatchmakingRuleSetRequest) throws InternalServiceException, UnsupportedRegionException, InvalidRequestException, AwsServiceException, SdkClientException, GameLiftException
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 via ValidateMatchmakingRuleSetRequest.builder()
validateMatchmakingRuleSetRequest - A Consumer that will call methods on ValidateMatchmakingRuleSetInput.Builder to create a
request.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2023. All rights reserved.