Class: Aws::GameLift::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::GameLift::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb
Overview
An API client for GameLift. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::GameLift::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_match(params = {}) ⇒ Struct
Registers a player's acceptance or rejection of a proposed FlexMatch match.
-
#claim_game_server(params = {}) ⇒ Types::ClaimGameServerOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#create_alias(params = {}) ⇒ Types::CreateAliasOutput
Creates an alias for a fleet.
-
#create_build(params = {}) ⇒ Types::CreateBuildOutput
Creates an Amazon GameLift build resource for your game server software and stores the software for deployment to hosting resources.
-
#create_container_fleet(params = {}) ⇒ Types::CreateContainerFleetOutput
Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers.
-
#create_container_group_definition(params = {}) ⇒ Types::CreateContainerGroupDefinitionOutput
Creates a
ContainerGroupDefinition
that describes a set of containers for hosting your game server with Amazon GameLift managed containers hosting. -
#create_fleet(params = {}) ⇒ Types::CreateFleetOutput
Creates a fleet of compute resources to host your game servers.
-
#create_fleet_locations(params = {}) ⇒ Types::CreateFleetLocationsOutput
Adds remote locations to a managed EC2 fleet or managed container fleet and begins populating the new locations with instances.
-
#create_game_server_group(params = {}) ⇒ Types::CreateGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#create_game_session(params = {}) ⇒ Types::CreateGameSessionOutput
Creates a multiplayer game session for players in a specific fleet location.
-
#create_game_session_queue(params = {}) ⇒ Types::CreateGameSessionQueueOutput
Creates a placement queue that processes requests for new game sessions.
-
#create_location(params = {}) ⇒ Types::CreateLocationOutput
Creates a custom location for use in an Anywhere fleet.
-
#create_matchmaking_configuration(params = {}) ⇒ Types::CreateMatchmakingConfigurationOutput
Defines a new matchmaking configuration for use with FlexMatch.
-
#create_matchmaking_rule_set(params = {}) ⇒ Types::CreateMatchmakingRuleSetOutput
Creates a new rule set for FlexMatch matchmaking.
-
#create_player_session(params = {}) ⇒ Types::CreatePlayerSessionOutput
Reserves an open player slot in a game session for a player.
-
#create_player_sessions(params = {}) ⇒ Types::CreatePlayerSessionsOutput
Reserves open slots in a game session for a group of players.
-
#create_script(params = {}) ⇒ Types::CreateScriptOutput
Creates a script resource for your Realtime Servers script.
-
#create_vpc_peering_authorization(params = {}) ⇒ Types::CreateVpcPeeringAuthorizationOutput
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.
-
#create_vpc_peering_connection(params = {}) ⇒ Struct
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.
-
#delete_alias(params = {}) ⇒ Struct
Deletes an alias.
-
#delete_build(params = {}) ⇒ Struct
Deletes a build.
-
#delete_container_fleet(params = {}) ⇒ Struct
Deletes all resources and information related to a container fleet and shuts down currently running fleet instances, including those in remote locations.
-
#delete_container_group_definition(params = {}) ⇒ Struct
Deletes a container group definition.
-
#delete_fleet(params = {}) ⇒ Struct
Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.
-
#delete_fleet_locations(params = {}) ⇒ Types::DeleteFleetLocationsOutput
Removes locations from a multi-location fleet.
-
#delete_game_server_group(params = {}) ⇒ Types::DeleteGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#delete_game_session_queue(params = {}) ⇒ Struct
Deletes a game session queue.
-
#delete_location(params = {}) ⇒ Struct
Deletes a custom location.
-
#delete_matchmaking_configuration(params = {}) ⇒ Struct
Permanently removes a FlexMatch matchmaking configuration.
-
#delete_matchmaking_rule_set(params = {}) ⇒ Struct
Deletes an existing matchmaking rule set.
-
#delete_scaling_policy(params = {}) ⇒ Struct
Deletes a fleet scaling policy.
-
#delete_script(params = {}) ⇒ Struct
Deletes a Realtime script.
-
#delete_vpc_peering_authorization(params = {}) ⇒ Struct
Cancels a pending VPC peering authorization for the specified VPC.
-
#delete_vpc_peering_connection(params = {}) ⇒ Struct
Removes a VPC peering connection.
-
#deregister_compute(params = {}) ⇒ Struct
Removes a compute resource from an Amazon GameLift Anywhere fleet.
-
#deregister_game_server(params = {}) ⇒ Struct
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#describe_alias(params = {}) ⇒ Types::DescribeAliasOutput
Retrieves properties for an alias.
-
#describe_build(params = {}) ⇒ Types::DescribeBuildOutput
Retrieves properties for a custom game build.
-
#describe_compute(params = {}) ⇒ Types::DescribeComputeOutput
Retrieves properties for a compute resource in an Amazon GameLift fleet.
-
#describe_container_fleet(params = {}) ⇒ Types::DescribeContainerFleetOutput
Retrieves the properties for a container fleet.
-
#describe_container_group_definition(params = {}) ⇒ Types::DescribeContainerGroupDefinitionOutput
Retrieves the properties of a container group definition, including all container definitions in the group.
-
#describe_ec2_instance_limits(params = {}) ⇒ Types::DescribeEC2InstanceLimitsOutput
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.
-
#describe_fleet_attributes(params = {}) ⇒ Types::DescribeFleetAttributesOutput
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region.
-
#describe_fleet_capacity(params = {}) ⇒ Types::DescribeFleetCapacityOutput
Retrieves the resource capacity settings for one or more fleets.
-
#describe_fleet_deployment(params = {}) ⇒ Types::DescribeFleetDeploymentOutput
Retrieves information about a managed container fleet deployment.
-
#describe_fleet_events(params = {}) ⇒ Types::DescribeFleetEventsOutput
Retrieves entries from a fleet's event log.
-
#describe_fleet_location_attributes(params = {}) ⇒ Types::DescribeFleetLocationAttributesOutput
Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.
-
#describe_fleet_location_capacity(params = {}) ⇒ Types::DescribeFleetLocationCapacityOutput
Retrieves the resource capacity settings for a fleet location.
-
#describe_fleet_location_utilization(params = {}) ⇒ Types::DescribeFleetLocationUtilizationOutput
Retrieves current usage data for a fleet location.
-
#describe_fleet_port_settings(params = {}) ⇒ Types::DescribeFleetPortSettingsOutput
Retrieves a fleet's inbound connection permissions.
-
#describe_fleet_utilization(params = {}) ⇒ Types::DescribeFleetUtilizationOutput
Retrieves utilization statistics for one or more fleets.
-
#describe_game_server(params = {}) ⇒ Types::DescribeGameServerOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#describe_game_server_group(params = {}) ⇒ Types::DescribeGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#describe_game_server_instances(params = {}) ⇒ Types::DescribeGameServerInstancesOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#describe_game_session_details(params = {}) ⇒ Types::DescribeGameSessionDetailsOutput
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.
-
#describe_game_session_placement(params = {}) ⇒ Types::DescribeGameSessionPlacementOutput
Retrieves information, including current status, about a game session placement request.
-
#describe_game_session_queues(params = {}) ⇒ Types::DescribeGameSessionQueuesOutput
Retrieves the properties for one or more game session queues.
-
#describe_game_sessions(params = {}) ⇒ Types::DescribeGameSessionsOutput
Retrieves a set of one or more game sessions in a specific fleet location.
-
#describe_instances(params = {}) ⇒ Types::DescribeInstancesOutput
Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status.
-
#describe_matchmaking(params = {}) ⇒ Types::DescribeMatchmakingOutput
Retrieves one or more matchmaking tickets.
-
#describe_matchmaking_configurations(params = {}) ⇒ Types::DescribeMatchmakingConfigurationsOutput
Retrieves the details of FlexMatch matchmaking configurations.
-
#describe_matchmaking_rule_sets(params = {}) ⇒ Types::DescribeMatchmakingRuleSetsOutput
Retrieves the details for FlexMatch matchmaking rule sets.
-
#describe_player_sessions(params = {}) ⇒ Types::DescribePlayerSessionsOutput
Retrieves properties for one or more player sessions.
-
#describe_runtime_configuration(params = {}) ⇒ Types::DescribeRuntimeConfigurationOutput
Retrieves a fleet's runtime configuration settings.
-
#describe_scaling_policies(params = {}) ⇒ Types::DescribeScalingPoliciesOutput
Retrieves all scaling policies applied to a fleet.
-
#describe_script(params = {}) ⇒ Types::DescribeScriptOutput
Retrieves properties for a Realtime script.
-
#describe_vpc_peering_authorizations(params = {}) ⇒ Types::DescribeVpcPeeringAuthorizationsOutput
Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
-
#describe_vpc_peering_connections(params = {}) ⇒ Types::DescribeVpcPeeringConnectionsOutput
Retrieves information on VPC peering connections.
-
#get_compute_access(params = {}) ⇒ Types::GetComputeAccessOutput
Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet.
-
#get_compute_auth_token(params = {}) ⇒ Types::GetComputeAuthTokenOutput
Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift fleet.
-
#get_game_session_log_url(params = {}) ⇒ Types::GetGameSessionLogUrlOutput
Retrieves the location of stored game session logs for a specified game session on Amazon GameLift managed fleets.
-
#get_instance_access(params = {}) ⇒ Types::GetInstanceAccessOutput
Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet.
-
#list_aliases(params = {}) ⇒ Types::ListAliasesOutput
Retrieves all aliases for this Amazon Web Services account.
-
#list_builds(params = {}) ⇒ Types::ListBuildsOutput
Retrieves build resources for all builds associated with the Amazon Web Services account in use.
-
#list_compute(params = {}) ⇒ Types::ListComputeOutput
Retrieves information on the compute resources in an Amazon GameLift fleet.
-
#list_container_fleets(params = {}) ⇒ Types::ListContainerFleetsOutput
Retrieves a collection of container fleet resources in an Amazon Web Services Region.
-
#list_container_group_definition_versions(params = {}) ⇒ Types::ListContainerGroupDefinitionVersionsOutput
Retrieves all versions of a container group definition.
-
#list_container_group_definitions(params = {}) ⇒ Types::ListContainerGroupDefinitionsOutput
Retrieves container group definitions for the Amazon Web Services account and Amazon Web Services Region.
-
#list_fleet_deployments(params = {}) ⇒ Types::ListFleetDeploymentsOutput
Retrieves a collection of container fleet deployments in an Amazon Web Services Region.
-
#list_fleets(params = {}) ⇒ Types::ListFleetsOutput
Retrieves a collection of fleet resources in an Amazon Web Services Region.
-
#list_game_server_groups(params = {}) ⇒ Types::ListGameServerGroupsOutput
Lists a game server groups.
-
#list_game_servers(params = {}) ⇒ Types::ListGameServersOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#list_locations(params = {}) ⇒ Types::ListLocationsOutput
Lists all custom and Amazon Web Services locations.
-
#list_scripts(params = {}) ⇒ Types::ListScriptsOutput
Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services account in use.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves all tags assigned to a Amazon GameLift resource.
-
#put_scaling_policy(params = {}) ⇒ Types::PutScalingPolicyOutput
Creates or updates a scaling policy for a fleet.
-
#register_compute(params = {}) ⇒ Types::RegisterComputeOutput
Registers a compute resource in an Amazon GameLift Anywhere fleet.
-
#register_game_server(params = {}) ⇒ Types::RegisterGameServerOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#request_upload_credentials(params = {}) ⇒ Types::RequestUploadCredentialsOutput
Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3.
-
#resolve_alias(params = {}) ⇒ Types::ResolveAliasOutput
Attempts to retrieve a fleet ID that is associated with an alias.
-
#resume_game_server_group(params = {}) ⇒ Types::ResumeGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#search_game_sessions(params = {}) ⇒ Types::SearchGameSessionsOutput
Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.
-
#start_fleet_actions(params = {}) ⇒ Types::StartFleetActionsOutput
Resumes certain types of activity on fleet instances that were suspended with [StopFleetActions][1].
-
#start_game_session_placement(params = {}) ⇒ Types::StartGameSessionPlacementOutput
Places a request for a new game session in a queue.
-
#start_match_backfill(params = {}) ⇒ Types::StartMatchBackfillOutput
Finds new players to fill open slots in currently running game sessions.
-
#start_matchmaking(params = {}) ⇒ Types::StartMatchmakingOutput
Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules.
-
#stop_fleet_actions(params = {}) ⇒ Types::StopFleetActionsOutput
Suspends certain types of activity in a fleet location.
-
#stop_game_session_placement(params = {}) ⇒ Types::StopGameSessionPlacementOutput
Cancels a game session placement that is in
PENDING
status. -
#stop_matchmaking(params = {}) ⇒ Struct
Cancels a matchmaking ticket or match backfill ticket that is currently being processed.
-
#suspend_game_server_group(params = {}) ⇒ Types::SuspendGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#tag_resource(params = {}) ⇒ Struct
Assigns a tag to an Amazon GameLift resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag assigned to a Amazon GameLift resource.
-
#update_alias(params = {}) ⇒ Types::UpdateAliasOutput
Updates properties for an alias.
-
#update_build(params = {}) ⇒ Types::UpdateBuildOutput
Updates metadata in a build resource, including the build name and version.
-
#update_container_fleet(params = {}) ⇒ Types::UpdateContainerFleetOutput
Updates the properties of a managed container fleet.
-
#update_container_group_definition(params = {}) ⇒ Types::UpdateContainerGroupDefinitionOutput
Updates properties in an existing container group definition.
-
#update_fleet_attributes(params = {}) ⇒ Types::UpdateFleetAttributesOutput
Updates a fleet's mutable attributes, such as game session protection and resource creation limits.
-
#update_fleet_capacity(params = {}) ⇒ Types::UpdateFleetCapacityOutput
Updates capacity settings for a managed EC2 fleet or managed container fleet.
-
#update_fleet_port_settings(params = {}) ⇒ Types::UpdateFleetPortSettingsOutput
Updates permissions that allow inbound traffic to connect to game sessions in the fleet.
-
#update_game_server(params = {}) ⇒ Types::UpdateGameServerOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#update_game_server_group(params = {}) ⇒ Types::UpdateGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups..
-
#update_game_session(params = {}) ⇒ Types::UpdateGameSessionOutput
Updates the mutable properties of a game session.
-
#update_game_session_queue(params = {}) ⇒ Types::UpdateGameSessionQueueOutput
Updates the configuration of a game session queue, which determines how the queue processes new game session requests.
-
#update_matchmaking_configuration(params = {}) ⇒ Types::UpdateMatchmakingConfigurationOutput
Updates settings for a FlexMatch matchmaking configuration.
-
#update_runtime_configuration(params = {}) ⇒ Types::UpdateRuntimeConfigurationOutput
Updates the runtime configuration for the specified fleet.
-
#update_script(params = {}) ⇒ Types::UpdateScriptOutput
Updates Realtime script metadata and content.
-
#validate_matchmaking_rule_set(params = {}) ⇒ Types::ValidateMatchmakingRuleSetOutput
Validates the syntax of a matchmaking rule or rule set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
451 452 453 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 451 def initialize(*args) super end |
Instance Method Details
#accept_match(params = {}) ⇒ Struct
Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in
the proposed match are placed into status REQUIRES_ACCEPTANCE
. This
is a trigger for your game to get acceptance from all players in each
ticket. Calls to this action are only valid for tickets that are in
this status; calls for tickets not in this status result in an error.
To register acceptance, specify the ticket ID, one or more players,
and an acceptance response. When all players have accepted, Amazon
GameLift advances the matchmaking tickets to status PLACING
, and
attempts to create a new game session for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:
If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set
CANCELLED
and processing is terminated.If all players in the ticket accepted the match, the ticket status is returned to
SEARCHING
to find a new match.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
521 522 523 524 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 521 def accept_match(params = {}, = {}) req = build_request(:accept_match, params) req.send_request() end |
#claim_game_server(params = {}) ⇒ Types::ClaimGameServerOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Locates an available game server and temporarily reserves it to host
gameplay and players. This operation is called from a game client or
client service (such as a matchmaker) to request hosting resources for
a new game session. In response, Amazon GameLift FleetIQ locates an
available game server, places it in CLAIMED
status for 60 seconds,
and returns connection information that players can use to connect to
the game server.
To claim a game server, identify a game server group. You can also
specify a game server ID, although this approach bypasses Amazon
GameLift FleetIQ placement optimization. Optionally, include game data
to pass to the game server at the start of a game session, such as a
game map or player information. Add filter options to further restrict
how a game server is chosen, such as only allowing game servers on
ACTIVE
instances to be claimed.
When a game server is successfully claimed, connection information is
returned. A claimed game server's utilization status remains
AVAILABLE
while the claim status is set 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
.If the game server is running on an instance in
DRAINING
status and the provided filter option does not allow placing onDRAINING
instances.
Learn more
625 626 627 628 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 625 def claim_game_server(params = {}, = {}) req = build_request(:claim_game_server, params) req.send_request() end |
#create_alias(params = {}) ⇒ Types::CreateAliasOutput
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
716 717 718 719 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 716 def create_alias(params = {}, = {}) req = build_request(:create_alias, params) req.send_request() end |
#create_build(params = {}) ⇒ Types::CreateBuildOutput
Creates an Amazon GameLift build resource for your game server software and stores the software for deployment to hosting resources. Combine game server binaries and dependencies into a single .zip file
Use the CLI command upload-build to quickly and simply create a new build and upload your game build .zip file to Amazon GameLift Amazon S3. This helper command eliminates the need to explicitly manage access permissions.
Alternatively, use the CreateBuild
action for the following
scenarios:
You want to create a build and upload a game build zip file from in an Amazon S3 location that you control. In this scenario, you need to give Amazon GameLift permission to access to the Amazon S3 bucket. With permission in place, call
CreateBuild
and specify a build name, the build's runtime operating system, and the Amazon S3 storage location where the build file is stored.You want to create a build and upload a local game build zip file to an Amazon S3 location that's controlled by Amazon GameLift. (See the
upload-build
CLI command for this scenario.) In this scenario, you need to request temporary access credentials to the Amazon GameLift Amazon S3 location. Specify a build name and the build's runtime operating system. The response provides an Amazon S3 location and a set of temporary access credentials. Use the credentials to upload your build files to the specified Amazon S3 location (see Uploading Objects in the Amazon S3 Developer Guide). You can't update build files after uploading them to Amazon GameLift Amazon S3.
If successful, this action creates a new build resource with a unique
build ID and places it in INITIALIZED
status. When the build reaches
READY
status, you can create fleets with it.
Learn more
890 891 892 893 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 890 def create_build(params = {}, = {}) req = build_request(:create_build, params) req.send_request() end |
#create_container_fleet(params = {}) ⇒ Types::CreateContainerFleetOutput
Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game servers. Use this operation to define how to deploy a container architecture onto each fleet instance and configure fleet settings. You can create a container fleet in any Amazon Web Services Regions that Amazon GameLift supports for multi-location fleets. A container fleet can be deployed to a single location or multiple locations. Container fleets are deployed with Amazon Linux 2023 as the instance operating system.
Define the fleet's container architecture using container group definitions. Each fleet can have one of the following container group types:
The game server container group runs your game server build and dependent software. Amazon GameLift deploys one or more replicas of this container group to each fleet instance. The number of replicas depends on the computing capabilities of the fleet instance in use.
An optional per-instance container group might be used to run other software that only needs to run once per instance, such as background services, logging, or test processes. One per-instance container group is deployed to each fleet instance.
Each container group can include the definition for one or more containers. A container definition specifies a container image that is stored in an Amazon Elastic Container Registry (Amazon ECR) public or private repository.
Request options
Use this operation to make the following types of requests. Most fleet settings have default values, so you can create a working fleet with a minimal configuration and default values, which you can customize later.
Create a fleet with no container groups. You can configure a container fleet and then add container group definitions later. In this scenario, no fleet instances are deployed, and the fleet can't host game sessions until you add a game server container group definition. Provide the following required parameter values:
FleetRoleArn
^
Create a fleet with a game server container group. Provide the following required parameter values:
FleetRoleArn
GameServerContainerGroupDefinitionName
Create a fleet with a game server container group and a per-instance container group. Provide the following required parameter values:
FleetRoleArn
GameServerContainerGroupDefinitionName
PerInstanceContainerGroupDefinitionName
Results
If successful, this operation creates a new container fleet resource,
places it in PENDING
status, and initiates the fleet creation
workflow. For fleets with container groups, this workflow starts a
fleet deployment and transitions the status to ACTIVE
. Fleets
without a container group are placed in CREATED
status.
You can update most of the properties of a fleet, including container group definitions, and deploy the update across all fleet instances. Use a fleet update to deploy a new game server version update across the container fleet.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1273 def create_container_fleet(params = {}, = {}) req = build_request(:create_container_fleet, params) req.send_request() end |
#create_container_group_definition(params = {}) ⇒ Types::CreateContainerGroupDefinitionOutput
Creates a ContainerGroupDefinition
that describes a set of
containers for hosting your game server with Amazon GameLift managed
containers hosting. An Amazon GameLift container group is similar to a
container task or pod. Use container group definitions when you create
a container fleet with CreateContainerFleet.
A container group definition determines how Amazon GameLift deploys your containers to each instance in a container fleet. You can maintain multiple versions of a container group definition.
There are two types of container groups:
A game server container group has the containers that run your game server application and supporting software. A game server container group can have these container types:
Game server container. This container runs your game server. You can define one game server container in a game server container group.
Support container. This container runs software in parallel with your game server. You can define up to 8 support containers in a game server group. When building a game server container group definition, you can choose to bundle your game server executable and all dependent software into a single game server container. Alternatively, you can separate the software into one game server container and one or more support containers.
On a container fleet instance, a game server container group can be deployed multiple times (depending on the compute resources of the instance). This means that all containers in the container group are replicated together.
A per-instance container group has containers for processes that aren't replicated on a container fleet instance. This might include background services, logging, test processes, or processes that need to persist independently of the game server container group. When building a per-instance container group, you can define up to 10 support containers.
Request options
Use this operation to make the following types of requests. You can specify values for the minimum required parameters and customize optional values later.
Create a game server container group definition. Provide the following required parameter values:
Name
ContainerGroupType
(GAME_SERVER
)OperatingSystem
(omit to use default value)TotalMemoryLimitMebibytes
(omit to use default value)TotalVcpuLimit
(omit to use default value)At least one
GameServerContainerDefinition
ContainerName
ImageUrl
PortConfiguration
ServerSdkVersion
(omit to use default value)
Create a per-instance container group definition. Provide the following required parameter values:
Name
ContainerGroupType
(PER_INSTANCE
)OperatingSystem
(omit to use default value)TotalMemoryLimitMebibytes
(omit to use default value)TotalVcpuLimit
(omit to use default value)At least one
SupportContainerDefinition
ContainerName
ImageUrl
Results
If successful, this request creates a ContainerGroupDefinition
resource and assigns a unique ARN value. You can update most
properties of a container group definition by calling
UpdateContainerGroupDefinition, and optionally save the update as a
new version.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 1621 def create_container_group_definition(params = {}, = {}) req = build_request(:create_container_group_definition, params) req.send_request() end |
#create_fleet(params = {}) ⇒ Types::CreateFleetOutput
Creates a fleet of compute resources to host your game servers. Use this operation to set up the following types of fleets based on compute type:
Managed EC2 fleet
An EC2 fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2)
instances. Your game server build is deployed to each fleet instance.
Amazon GameLift manages the fleet's instances and controls the
lifecycle of game server processes, which host game sessions for
players. EC2 fleets can have instances in multiple locations. Each
instance in the fleet is designated a Compute
.
To create an EC2 fleet, provide these required parameters:
Either
BuildId
orScriptId
ComputeType
set toEC2
(the default value)EC2InboundPermissions
EC2InstanceType
FleetType
Name
RuntimeConfiguration
with at least oneServerProcesses
configuration
If successful, this operation creates a new fleet resource and places
it in NEW
status while Amazon GameLift initiates the fleet creation
workflow. To debug your fleet, fetch logs, view performance
metrics or other actions on the fleet, create a development fleet with
port 22/3389 open. As a best practice, we recommend opening ports for
remote access only when you need them and closing them when you're
finished.
When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling on/off for each location.
Anywhere fleet
An Anywhere fleet represents compute resources that are not owned or managed by Amazon GameLift. You might create an Anywhere fleet with your local machine for testing, or use one to host game servers with on-premises hardware or other game hosting solutions.
To create an Anywhere fleet, provide these required parameters:
ComputeType
set toANYWHERE
Locations
specifying a custom locationName
If successful, this operation creates a new fleet resource and places
it in ACTIVE
status. You can register computes with a fleet in
ACTIVE
status.
Learn more
2036 2037 2038 2039 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2036 def create_fleet(params = {}, = {}) req = build_request(:create_fleet, params) req.send_request() end |
#create_fleet_locations(params = {}) ⇒ Types::CreateFleetLocationsOutput
Adds remote locations to a managed EC2 fleet or managed container fleet and begins populating the new locations with instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.
To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.
If successful, this operation returns the list of added locations with
their status set to NEW
. Amazon GameLift initiates the process of
starting an instance in each added location. You can track the status
of each new location by monitoring location creation events using
DescribeFleetEvents.
Learn more
Amazon GameLift service locations for managed hosting.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2115 def create_fleet_locations(params = {}, = {}) req = build_request(:create_fleet_locations, params) req.send_request() end |
#create_game_server_group(params = {}) ⇒ Types::CreateGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Creates a Amazon GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services account, and establishes a link between the two groups. You can view the status of your game server groups in the Amazon GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.
Before creating a new game server group, you must have the following:
An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.
An IAM role that extends limited access to your Amazon Web Services account to allow Amazon GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the Amazon GameLift FleetIQ Developer Guide.
To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a Amazon GameLift FleetIQ metric.
Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by Amazon GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.
Learn more
2361 2362 2363 2364 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2361 def create_game_server_group(params = {}, = {}) req = build_request(:create_game_server_group, params) req.send_request() end |
#create_game_session(params = {}) ⇒ Types::CreateGameSessionOutput
Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the Amazon GameLift game session placement feature with StartGameSessionPlacement , which uses the FleetIQ algorithm and queues to optimize the placement process.
When creating a game session, you specify exactly where you want to
place it and provide a set of game session configuration settings. The
target fleet must be in ACTIVE
status.
You can use this operation in the following ways:
To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.
To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.
To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.
If successful, Amazon GameLift initiates a workflow to start a new
game session and returns a GameSession
object containing the game
session configuration and status. When the game session status is
ACTIVE
, it is updated with connection information and you can create
player sessions for the game session. By default, newly created game
sessions are open to new players. You can restrict new player access
by using UpdateGameSession to change the game session's player
session creation policy.
Amazon GameLift retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.
Available in Amazon GameLift Local.
Learn more
2551 2552 2553 2554 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2551 def create_game_session(params = {}, = {}) req = build_request(:create_game_session, params) req.send_request() end |
#create_game_session_queue(params = {}) ⇒ Types::CreateGameSessionQueueOutput
Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.
A game session queue is configured with a set of destinations (Amazon GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.
The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.
To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.
If successful, a new GameSessionQueue
object is returned with an
assigned queue ARN. New game session requests, which are submitted to
queue with StartGameSessionPlacement or StartMatchmaking,
reference a queue's name or ARN.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
2733 2734 2735 2736 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2733 def create_game_session_queue(params = {}, = {}) req = build_request(:create_game_session_queue, params) req.send_request() end |
#create_location(params = {}) ⇒ Types::CreateLocationOutput
Creates a custom location for use in an Anywhere fleet.
2780 2781 2782 2783 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 2780 def create_location(params = {}, = {}) req = build_request(:create_location, params) req.send_request() end |
#create_matchmaking_configuration(params = {}) ⇒ Types::CreateMatchmakingConfigurationOutput
Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with Amazon GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration.
To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.
In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.
Learn more
3003 3004 3005 3006 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3003 def create_matchmaking_configuration(params = {}, = {}) req = build_request(:create_matchmaking_configuration, params) req.send_request() end |
#create_matchmaking_rule_set(params = {}) ⇒ Types::CreateMatchmakingRuleSetOutput
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
3087 3088 3089 3090 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3087 def create_matchmaking_rule_set(params = {}, = {}) req = build_request(:create_matchmaking_rule_set, params) req.send_request() end |
#create_player_session(params = {}) ⇒ Types::CreatePlayerSessionOutput
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 Amazon GameLift service.
Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
3162 3163 3164 3165 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3162 def create_player_session(params = {}, = {}) req = build_request(:create_player_session, params) req.send_request() end |
#create_player_sessions(params = {}) ⇒ Types::CreatePlayerSessionsOutput
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 Amazon GameLift service.
Player sessions cannot be updated.
The maximum number of players per game session is 200. It is not adjustable.
Related actions
3243 3244 3245 3246 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3243 def create_player_sessions(params = {}, = {}) req = build_request(:create_player_sessions, params) req.send_request() end |
#create_script(params = {}) ⇒ Types::CreateScriptOutput
Creates a script resource for your Realtime Servers script. Realtime scripts are JavaScript files that provide configuration settings and optional custom game logic for your game. Script logic is executed during an active game session. To deploy Realtime Servers for hosting, create an Amazon GameLift managed fleet with the script.
To create a script resource, specify a script name and provide the script file(s). The script files and all dependencies must be combined into a single .zip file. You can upload 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, Amazon GameLift creates a new script resource with a unique script ID. The script is uploaded to an Amazon S3 bucket that is owned by Amazon GameLift.
Learn more
Amazon GameLift Realtime Servers
Set Up a Role for Amazon GameLift Access
Related actions
3385 3386 3387 3388 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3385 def create_script(params = {}, = {}) req = build_request(:create_script, params) req.send_request() end |
#create_vpc_peering_authorization(params = {}) ⇒ Types::CreateVpcPeeringAuthorizationOutput
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
3473 3474 3475 3476 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3473 def (params = {}, = {}) req = build_request(:create_vpc_peering_authorization, params) req.send_request() end |
#create_vpc_peering_connection(params = {}) ⇒ Struct
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
3553 3554 3555 3556 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3553 def create_vpc_peering_connection(params = {}, = {}) req = build_request(:create_vpc_peering_connection, params) req.send_request() end |
#delete_alias(params = {}) ⇒ Struct
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
3587 3588 3589 3590 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3587 def delete_alias(params = {}, = {}) req = build_request(:delete_alias, params) req.send_request() end |
#delete_build(params = {}) ⇒ Struct
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
3626 3627 3628 3629 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3626 def delete_build(params = {}, = {}) req = build_request(:delete_build, params) req.send_request() end |
#delete_container_fleet(params = {}) ⇒ Struct
Deletes all resources and information related to a container fleet and
shuts down currently running fleet instances, including those in
remote locations. The container fleet must be in ACTIVE
status to be
deleted.
To delete a fleet, specify the fleet ID to be terminated. During the
deletion process, the fleet status is changed to DELETING
.
Learn more
3663 3664 3665 3666 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3663 def delete_container_fleet(params = {}, = {}) req = build_request(:delete_container_fleet, params) req.send_request() end |
#delete_container_group_definition(params = {}) ⇒ Struct
Deletes a container group definition. You can delete a container group definition if there are no fleets using the definition.
Request options:
Delete an entire container group definition, including all versions. Specify the container group definition name, or use an ARN value without the version number.
Delete a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number.
Keep the newest versions and delete all older versions. Specify the container group definition name and the number of versions to retain. For example, set
VersionCountToRetain
to 5 to delete all but the five most recent versions.
Learn more
^
3721 3722 3723 3724 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3721 def delete_container_group_definition(params = {}, = {}) req = build_request(:delete_container_group_definition, params) req.send_request() end |
#delete_fleet(params = {}) ⇒ Struct
Deletes all resources and information related to a fleet and shuts down any currently running fleet instances, including those in remote locations.
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 emitted.
Learn more
3767 3768 3769 3770 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3767 def delete_fleet(params = {}, = {}) req = build_request(:delete_fleet, params) req.send_request() end |
#delete_fleet_locations(params = {}) ⇒ Types::DeleteFleetLocationsOutput
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
3825 3826 3827 3828 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3825 def delete_fleet_locations(params = {}, = {}) req = build_request(:delete_fleet_locations, params) req.send_request() end |
#delete_game_server_group(params = {}) ⇒ Types::DeleteGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:
The game server group
The corresponding Auto Scaling group
All game servers that are currently running in the group
To delete a game server group, identify the game server group to
delete and specify the type of delete operation to initiate. Game
server groups can only be deleted if they are in ACTIVE
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, Amazon GameLift FleetIQ can begin deleting
resources. If any of the delete operations fail, the game server group
is placed in ERROR
status.
Amazon GameLift FleetIQ emits delete events to Amazon CloudWatch.
Learn more
3919 3920 3921 3922 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3919 def delete_game_server_group(params = {}, = {}) req = build_request(:delete_game_server_group, params) req.send_request() end |
#delete_game_session_queue(params = {}) ⇒ Struct
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.
3949 3950 3951 3952 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3949 def delete_game_session_queue(params = {}, = {}) req = build_request(:delete_game_session_queue, params) req.send_request() end |
#delete_location(params = {}) ⇒ Struct
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.
3979 3980 3981 3982 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 3979 def delete_location(params = {}, = {}) req = build_request(:delete_location, params) req.send_request() end |
#delete_matchmaking_configuration(params = {}) ⇒ Struct
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.
4004 4005 4006 4007 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4004 def delete_matchmaking_configuration(params = {}, = {}) req = build_request(:delete_matchmaking_configuration, params) req.send_request() end |
#delete_matchmaking_rule_set(params = {}) ⇒ Struct
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
^
4040 4041 4042 4043 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4040 def delete_matchmaking_rule_set(params = {}, = {}) req = build_request(:delete_matchmaking_rule_set, params) req.send_request() end |
#delete_scaling_policy(params = {}) ⇒ Struct
Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and Amazon GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
To temporarily suspend scaling policies, use StopFleetActions. This operation suspends all policies for the fleet.
4078 4079 4080 4081 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4078 def delete_scaling_policy(params = {}, = {}) req = build_request(:delete_scaling_policy, params) req.send_request() end |
#delete_script(params = {}) ⇒ Struct
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
4122 4123 4124 4125 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4122 def delete_script(params = {}, = {}) req = build_request(:delete_script, params) req.send_request() end |
#delete_vpc_peering_authorization(params = {}) ⇒ Struct
Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, use DeleteVpcPeeringConnection.
Related actions
4170 4171 4172 4173 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4170 def (params = {}, = {}) req = build_request(:delete_vpc_peering_authorization, params) req.send_request() end |
#delete_vpc_peering_connection(params = {}) ⇒ Struct
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
4213 4214 4215 4216 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4213 def delete_vpc_peering_connection(params = {}, = {}) req = build_request(:delete_vpc_peering_connection, params) req.send_request() end |
#deregister_compute(params = {}) ⇒ Struct
Removes a compute resource from an Amazon GameLift Anywhere fleet. Deregistered computes can no longer host game sessions through Amazon GameLift.
For an Anywhere fleet that's running the Amazon GameLift Agent, the Agent handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the Agent, call this operation to deregister fleet computes.
To deregister a compute, call this operation from the compute that's being deregistered and specify the compute name and the fleet ID.
4251 4252 4253 4254 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4251 def deregister_compute(params = {}, = {}) req = build_request(:deregister_compute, params) req.send_request() end |
#deregister_game_server(params = {}) ⇒ Struct
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.
To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.
Learn more
4296 4297 4298 4299 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4296 def deregister_game_server(params = {}, = {}) req = build_request(:deregister_game_server, params) req.send_request() end |
#describe_alias(params = {}) ⇒ Types::DescribeAliasOutput
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
4346 4347 4348 4349 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4346 def describe_alias(params = {}, = {}) req = build_request(:describe_alias, params) req.send_request() end |
#describe_build(params = {}) ⇒ Types::DescribeBuildOutput
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
4396 4397 4398 4399 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4396 def describe_build(params = {}, = {}) req = build_request(:describe_build, params) req.send_request() end |
#describe_compute(params = {}) ⇒ Types::DescribeComputeOutput
Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all computes in a fleet, call ListCompute.
To request information on a specific compute, provide the fleet ID and compute name.
If successful, this operation returns details for the requested compute resource. Depending on the fleet's compute type, the result includes the following information:
For managed EC2 fleets, this operation returns information about the EC2 instance.
For Anywhere fleets, this operation returns information about the registered compute.
4462 4463 4464 4465 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4462 def describe_compute(params = {}, = {}) req = build_request(:describe_compute, params) req.send_request() end |
#describe_container_fleet(params = {}) ⇒ Types::DescribeContainerFleetOutput
Retrieves the properties for a container fleet. When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
Request options
- Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value.
^
Results
If successful, a ContainerFleet
object is returned. This object
includes the fleet properties, including information about the most
recent deployment.
4544 4545 4546 4547 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4544 def describe_container_fleet(params = {}, = {}) req = build_request(:describe_container_fleet, params) req.send_request() end |
#describe_container_group_definition(params = {}) ⇒ Types::DescribeContainerGroupDefinitionOutput
Retrieves the properties of a container group definition, including all container definitions in the group.
Request options:
Retrieve the latest version of a container group definition. Specify the container group definition name only, or use an ARN value without a version number.
Retrieve a particular version. Specify the container group definition name and a version number, or use an ARN value that includes the version number.
Results:
If successful, this operation returns the complete properties of a container group definition version.
Learn more
^
4658 4659 4660 4661 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4658 def describe_container_group_definition(params = {}, = {}) req = build_request(:describe_container_group_definition, params) req.send_request() end |
#describe_ec2_instance_limits(params = {}) ⇒ Types::DescribeEC2InstanceLimitsOutput
Retrieves the instance limits and current utilization for an Amazon Web Services Region or location. Instance limits control the number of instances, per instance type, per location, that your Amazon Web Services account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your Amazon GameLift fleets. You can request a limit increase for your account by using the Service limits page in the Amazon GameLift console.
Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an Amazon Web Services Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:
Request specifies the Region
ap-northeast-1
with no location. The result is limits and usage data on all instance types that are deployed inus-east-2
, by all of the fleets that reside inap-northeast-1
.Request specifies the Region
us-east-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside inus-east-2
. These limits do not affect fleets in any other Regions that deploy instances toca-central-1
.Request specifies the Region
eu-west-1
with locationca-central-1
. The result is limits and usage data on all instance types that are deployed inca-central-1
, by all of the fleets that reside ineu-west-1
.
This operation can be used in the following ways:
To get limit and usage data for all instance types that are deployed in an Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only. Optionally, specify a single instance type to retrieve information for.
To get limit and usage data for all instance types that are deployed to a remote location by fleets that reside in different Amazon Web Services Region: Provide both the Amazon Web Services Region and the remote location. Optionally, specify a single instance type to retrieve information for.
If successful, an EC2InstanceLimits
object is returned with limits
and usage data for each requested instance type.
Learn more
4756 4757 4758 4759 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4756 def describe_ec2_instance_limits(params = {}, = {}) req = build_request(:describe_ec2_instance_limits, params) req.send_request() end |
#describe_fleet_attributes(params = {}) ⇒ Types::DescribeFleetAttributesOutput
Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing hardware and deployment configuration for instances in the fleet.
You can use this operation in the following ways:
To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes
object is returned for each fleet
requested, unless the fleet identifier is not found.
Learn more
Setting up Amazon GameLift fleets
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4864 4865 4866 4867 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4864 def describe_fleet_attributes(params = {}, = {}) req = build_request(:describe_fleet_attributes, params) req.send_request() end |
#describe_fleet_capacity(params = {}) ⇒ Types::DescribeFleetCapacityOutput
Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for game server container groups.
With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.
This operation can be used in the following ways:
To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity
object is returned for each requested
fleet ID. Each FleetCapacity
object includes a Location
property,
which is set to the fleet's home Region. Capacity values are returned
only for fleets that currently exist.
Learn more
Setting up Amazon GameLift fleets
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4967 4968 4969 4970 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 4967 def describe_fleet_capacity(params = {}, = {}) req = build_request(:describe_fleet_capacity, params) req.send_request() end |
#describe_fleet_deployment(params = {}) ⇒ Types::DescribeFleetDeploymentOutput
Retrieves information about a managed container fleet deployment.
Request options
Get information about the latest deployment for a specific fleet. Provide the fleet ID or ARN.
Get information about a specific deployment. Provide the fleet ID or ARN and the deployment ID.
Results
If successful, a FleetDeployment
object is returned.
5025 5026 5027 5028 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5025 def describe_fleet_deployment(params = {}, = {}) req = build_request(:describe_fleet_deployment, params) req.send_request() end |
#describe_fleet_events(params = {}) ⇒ Types::DescribeFleetEventsOutput
Retrieves entries from a fleet's event log. Fleet events are initiated by changes in status, such as during fleet creation and termination, changes in capacity, etc. If a fleet has multiple locations, events are also initiated by changes to status and capacity in remote locations.
You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a collection of event log entries matching the request are returned.
Learn more
Setting up Amazon GameLift fleets
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5110 5111 5112 5113 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5110 def describe_fleet_events(params = {}, = {}) req = build_request(:describe_fleet_events, params) req.send_request() end |
#describe_fleet_location_attributes(params = {}) ⇒ Types::DescribeFleetLocationAttributesOutput
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
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5201 5202 5203 5204 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5201 def describe_fleet_location_attributes(params = {}, = {}) req = build_request(:describe_fleet_location_attributes, params) req.send_request() end |
#describe_fleet_location_capacity(params = {}) ⇒ Types::DescribeFleetLocationCapacityOutput
Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a managed container fleet, this operation also returns counts for game server container groups.
Use this operation to retrieve capacity information for a fleet's
remote location or home Region (you can also retrieve home Region
capacity by calling DescribeFleetCapacity
).
To retrieve capacity data, identify a fleet and location.
If successful, a FleetCapacity
object is returned for the requested
fleet location.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
5277 5278 5279 5280 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5277 def describe_fleet_location_capacity(params = {}, = {}) req = build_request(:describe_fleet_location_capacity, params) req.send_request() end |
#describe_fleet_location_utilization(params = {}) ⇒ Types::DescribeFleetLocationUtilizationOutput
Retrieves current usage data for a fleet location. Utilization data
provides a snapshot of current game hosting activity at the requested
location. Use this operation to retrieve utilization information for a
fleet's remote location or home Region (you can also retrieve home
Region utilization by calling DescribeFleetUtilization
).
To retrieve utilization data, identify a fleet and location.
If successful, a FleetUtilization
object is returned for the
requested fleet location.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
5341 5342 5343 5344 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5341 def describe_fleet_location_utilization(params = {}, = {}) req = build_request(:describe_fleet_location_utilization, params) req.send_request() end |
#describe_fleet_port_settings(params = {}) ⇒ Types::DescribeFleetPortSettingsOutput
Retrieves a fleet's inbound connection permissions. Inbound permissions specify IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game server processes that are running in the fleet must use a port that falls within this range. To connect to game server processes on a managed container fleet, the port settings should include one or more of the container fleet's connection ports.
Use this operation in the following ways:
To retrieve the port settings for a fleet, identify the fleet's unique identifier.
To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.
If successful, a set of IpPermission
objects is returned for the
requested fleet ID. When specifying a location, this operation returns
a pending status. If the requested fleet has been deleted, the result
set is empty.
Learn more
5415 5416 5417 5418 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5415 def describe_fleet_port_settings(params = {}, = {}) req = build_request(:describe_fleet_port_settings, params) req.send_request() end |
#describe_fleet_utilization(params = {}) ⇒ Types::DescribeFleetUtilizationOutput
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.
Learn more
Setting up Amazon GameLift Fleets
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5511 5512 5513 5514 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5511 def describe_fleet_utilization(params = {}, = {}) req = build_request(:describe_fleet_utilization, params) req.send_request() end |
#describe_game_server(params = {}) ⇒ Types::DescribeGameServerOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.
To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.
Learn more
5571 5572 5573 5574 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5571 def describe_game_server(params = {}, = {}) req = build_request(:describe_game_server, params) req.send_request() end |
#describe_game_server_group(params = {}) ⇒ Types::DescribeGameServerGroupOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves information on a game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.
To get attributes for a game server group, provide a group name or ARN
value. If successful, a GameServerGroup
object is returned.
Learn more
5632 5633 5634 5635 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5632 def describe_game_server_group(params = {}, = {}) req = build_request(:describe_game_server_group, params) req.send_request() end |
#describe_game_server_instances(params = {}) ⇒ Types::DescribeGameServerInstancesOutput
This operation is used with the Amazon GameLift FleetIQ solution and game server groups.
Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers.
To request status for all instances in the game server group, provide
a game server group ID only. To request status for specific instances,
provide the game server group ID and one or more instance IDs. Use the
pagination parameters to retrieve results in sequential segments. If
successful, a collection of GameServerInstance
objects is returned.
This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.
Learn more
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5713 5714 5715 5716 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5713 def describe_game_server_instances(params = {}, = {}) req = build_request(:describe_game_server_instances, params) req.send_request() end |
#describe_game_session_details(params = {}) ⇒ Types::DescribeGameSessionDetailsOutput
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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5839 5840 5841 5842 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5839 def describe_game_session_details(params = {}, = {}) req = build_request(:describe_game_session_details, params) req.send_request() end |
#describe_game_session_placement(params = {}) ⇒ Types::DescribeGameSessionPlacementOutput
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.
5902 5903 5904 5905 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5902 def describe_game_session_placement(params = {}, = {}) req = build_request(:describe_game_session_placement, params) req.send_request() end |
#describe_game_session_queues(params = {}) ⇒ Types::DescribeGameSessionQueuesOutput
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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5977 5978 5979 5980 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 5977 def describe_game_session_queues(params = {}, = {}) req = build_request(:describe_game_session_queues, params) req.send_request() end |
#describe_game_sessions(params = {}) ⇒ Types::DescribeGameSessionsOutput
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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6111 6112 6113 6114 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6111 def describe_game_sessions(params = {}, = {}) req = build_request(:describe_game_sessions, params) req.send_request() end |
#describe_instances(params = {}) ⇒ Types::DescribeInstancesOutput
Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including instance ID, connection data, and status. You can use this operation with a multi-location fleet to get location-specific instance information. As an alternative, use the operations ListCompute and DescribeCompute to retrieve information for compute resources, including EC2 and Anywhere fleets.
You can call this operation in the following ways:
To get information on all instances in a fleet's home Region, specify the fleet ID.
To get information on all instances in a fleet's remote location, specify the fleet ID and location name.
To get information on a specific instance in a fleet, specify the fleet ID and instance ID.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, this operation returns Instance
objects for each
requested instance, listed in no particular order. If you call this
operation for an Anywhere fleet, you receive an
InvalidRequestException.
Learn more
Remotely connect to fleet instances
Related actions
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6216 6217 6218 6219 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6216 def describe_instances(params = {}, = {}) req = build_request(:describe_instances, params) req.send_request() end |
#describe_matchmaking(params = {}) ⇒ Types::DescribeMatchmakingOutput
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
6293 6294 6295 6296 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6293 def describe_matchmaking(params = {}, = {}) req = build_request(:describe_matchmaking, params) req.send_request() end |
#describe_matchmaking_configurations(params = {}) ⇒ Types::DescribeMatchmakingConfigurationsOutput
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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6385 6386 6387 6388 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6385 def describe_matchmaking_configurations(params = {}, = {}) req = build_request(:describe_matchmaking_configurations, params) req.send_request() end |
#describe_matchmaking_rule_sets(params = {}) ⇒ Types::DescribeMatchmakingRuleSetsOutput
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
^
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6450 6451 6452 6453 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6450 def describe_matchmaking_rule_sets(params = {}, = {}) req = build_request(:describe_matchmaking_rule_sets, params) req.send_request() end |
#describe_player_sessions(params = {}) ⇒ Types::DescribePlayerSessionsOutput
Retrieves properties for one or more player sessions.
This action can be used in the following ways:
To retrieve a specific player session, provide the player session ID only.
To retrieve all player sessions in a game session, provide the game session ID only.
To retrieve all player sessions for a specific player, provide a player ID only.
To request player sessions, specify either a player session ID, game
session ID, or player ID. You can filter this request by player
session status. If you provide a specific PlayerSessionId
or
PlayerId
, Amazon GameLift ignores the filter criteria. Use the
pagination parameters to retrieve results as a set of sequential
pages.
If successful, a PlayerSession
object is returned for each session
that matches the request.
Related actions
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6568 6569 6570 6571 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6568 def describe_player_sessions(params = {}, = {}) req = build_request(:describe_player_sessions, params) req.send_request() end |
#describe_runtime_configuration(params = {}) ⇒ Types::DescribeRuntimeConfigurationOutput
Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how they run, and how many run concurrently on computes in managed EC2 and Anywhere fleets. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.
To get the current runtime configuration for a fleet, provide the fleet ID.
If successful, a RuntimeConfiguration
object is returned for the
requested fleet. If the requested fleet has been deleted, the result
set is empty.
Learn more
6624 6625 6626 6627 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6624 def describe_runtime_configuration(params = {}, = {}) req = build_request(:describe_runtime_configuration, params) req.send_request() end |
#describe_scaling_policies(params = {}) ⇒ Types::DescribeScalingPoliciesOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6720 6721 6722 6723 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/client.rb', line 6720 def describe_scaling_policies(params = {}, = {}) req = build_request(:describe_scaling_policies, params) req.send_request() end |
#describe_script(params = {}) ⇒ Types::DescribeScriptOutput
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