The AWS region to connect to. The region is used to construct
the client endpoint. Defaults to ENV['AWS_REGION'].
Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

:retry_limit(Integer)
— default:
3
—

The maximum number of times to retry failed requests. Only
~ 500 level server errors and certain ~ 400 level client errors
are retried. Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors and auth
errors from expired credentials. See Plugins::RetryErrors for more details.

Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP
requests are made, and retries are disabled. See Plugins::StubResponses for more details.

:validate_params(Boolean)
— default:
true
—

When true, request parameters are validated before
sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#accept_match(options = {}) ⇒ 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 the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.

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, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift. See Uploading Your Game for more information.

To create new builds quickly and easily, use the AWS CLI command upload-build. This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. See Upload Build Files to Amazon GameLift for more help.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

Store a build file in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. See Create a Build with Files in Amazon S3 for detailed help. To create a new build record using files in your Amazon S3 bucket, call CreateBuild and specify a build name, operating system, and the storage location of your game build.

Upload a build file directly to Amazon GameLift's Amazon S3 account. To use this option, you first call CreateBuild with a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the storage location (see the Amazon S3 topic Uploading Objects). You can upload files to a location only once.

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

Information indicating where your game build files are stored. Use this
parameter only when creating a build with files stored in an Amazon S3
bucket that you own. The storage location must specify an Amazon S3
bucket name and key, as well as a role ARN that you set up to allow
Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be
in the same region that you want to create a new build in.

:operating_system(String)
—

Operating system that the game server binaries are built to run on. This
value determines the type of fleet resources that you can use for this
build. If your game build contains multiple executables, they all must
run on the same operating system. If an operating system is not
specified when creating a build, Amazon GameLift uses the default value
(WINDOWS_2012). This value cannot be changed later.

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy your game build to run on each instance.

To create a new fleet, you must specify the following: (1) a fleet name, (2) the build ID of a successfully uploaded game build, (3) an EC2 instance type, and (4) a run-time configuration, which describes the server processes to run on each instance in the fleet. If you don't specify a fleet type (on-demand or spot), the new fleet uses on-demand instances by default.

Descriptive label that is associated with a fleet. Fleet names do not
need to be unique.

:description(String)
—

Human-readable description of a fleet.

:build_id(required, String)
—

Unique identifier for a build to be deployed on the new fleet. The build
must have been successfully uploaded to Amazon GameLift and be in a
READY status. This fleet setting cannot be changed once the fleet is
created.

:server_launch_path(String)
—

This parameter is no longer used. Instead, specify a server launch path
using the RuntimeConfiguration parameter. (Requests that specify a
server launch path and launch parameters instead of a run-time
configuration will continue to work.)

:server_launch_parameters(String)
—

This parameter is no longer used. Instead, specify server launch
parameters in the RuntimeConfiguration parameter. (Requests that
specify a server launch path and launch parameters instead of a run-time
configuration will continue to work.)

:log_paths(Array<String>)
—

This parameter is no longer used. Instead, to specify where Amazon
GameLift should store log files once a server process shuts down, use
the Amazon GameLift server API ProcessReady() and specify one or more
directory paths in logParameters. See more information in the Server
API Reference.

:ec2_instance_type(required, String)
—

Name of an EC2 instance type that is supported in Amazon GameLift. A
fleet instance type determines the computing resources of each instance
in the fleet, including CPU, memory, storage, and networking capacity.
Amazon GameLift supports the following EC2 instance types. See Amazon
EC2 Instance Types for detailed descriptions.

Range of IP addresses and port settings that permit inbound traffic to
access server processes running on the fleet. If no inbound permissions
are set, including both IP address range and port range, the server
processes in the fleet cannot accept connections. You can specify one or
more sets of permissions for a fleet.

:new_game_session_protection_policy(String)
—

Game session protection policy to apply to all instances in this fleet.
If this parameter is not set, instances in this fleet default to no
protection. You can change a fleet\'s protection policy using
UpdateFleetAttributes, but this change will only affect sessions
created after the policy change. You can also set protection for
individual instances using UpdateGameSession.

NoProtection -- The game session can be terminated during a
scale-down event.

FullProtection -- If the game session is in an ACTIVE status, it
cannot be terminated during a scale-down event.

Instructions for launching server processes on each instance in the
fleet. The run-time configuration for a fleet has a collection of server
process configurations, one for each type of server process to run on an
instance. A server process configuration specifies the location of the
server executable, launch parameters, and the number of concurrent
processes with that configuration to maintain on each instance. A
CreateFleet request must include a run-time configuration with at least
one server process configuration; otherwise the request fails with an
invalid request exception. (This parameter replaces the parameters
ServerLaunchPath and ServerLaunchParameters; requests that contain
values for these parameters instead of a run-time configuration will
continue to work.)

Policy that limits the number of game sessions an individual player can
create over a span of time for this fleet.

:metric_groups(Array<String>)
—

Name of a metric group to add this fleet to. A metric group tracks
metrics across all fleets in the group. Use an existing metric group
name to add this fleet to the group, or use a new name to create a new
metric group. A fleet can only be included in one metric group at a
time.

:peer_vpc_aws_account_id(String)
—

Unique identifier for the AWS account with the VPC that you want to peer
your Amazon GameLift fleet with. You can find your Account ID in the AWS
Management Console under account settings.

:peer_vpc_id(String)
—

Unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same region where your fleet is
deployed. To get VPC information, including IDs, use the Virtual Private
Cloud service tools, including the VPC Dashboard in the AWS Management
Console.

:fleet_type(String)
—

Indicates whether to use on-demand instances or spot instances for this
fleet. If empty, the default is ON_DEMAND. Both categories of instances
use identical hardware and configurations, based on the instance type
selected for this fleet. You can acquire on-demand instances at any time
for a fixed price and keep them as long as you need them. Spot instances
have lower prices, but spot pricing is variable, and while in use they
can be interrupted (with a two-minute notification). Learn more about
Amazon GameLift spot instances with at Choose Computing Resources.

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.

Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.

Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.

Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Set of custom properties for a game session, formatted as key:value
pairs. These properties are passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session).

:creator_id(String)
—

Unique identifier for a player or entity creating the game session. This
ID is used to enforce a resource protection policy (if one exists) that
limits the number of concurrent active game sessions one player can
have.

:game_session_id(String)
—

This parameter is no longer preferred. Please use IdempotencyToken
instead. Custom string that uniquely identifies a request for a new
game session. Maximum token length is 48 characters. If provided, this
string is included in the new game session\'s ID. (A game session ARN
has the following format: arn:aws:gamelift:<region>::gamesession/<fleet
ID>/<custom ID string or idempotency token>.)

:idempotency_token(String)
—

Custom string that uniquely identifies a request for a new game session.
Maximum token length is 48 characters. If provided, this string is
included in the new game session\'s ID. (A game session ARN has the
following format: arn:aws:gamelift:<region>::gamesession/<fleet
ID>/<custom ID string or idempotency token>.) Idempotency tokens remain
in use for 30 days after a game session has ended; game session objects
are retained for this time period and then deleted.

:game_session_data(String)
—

Set of custom game session properties, formatted as a single string
value. This data is passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session).

Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.

Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.

Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.

To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.

Collection of latency policies to apply when processing game sessions
placement requests with player latency information. Multiple policies
are evaluated in order of the maximum latency value, starting with the
lowest latency values. With just one policy, it is enforced at the start
of the game session placement for the duration period. With multiple
policies, each policy is enforced consecutively for its duration period.
For example, a queue might enforce a 60-second policy followed by a
120-second policy, and then no policy for the remainder of the
placement. A player latency policy must set a value for
MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API
requests will fail.

List of fleets that can be used to fulfill game session placement
requests in the queue. Fleets are identified by either a fleet ARN or a
fleet alias ARN. Destinations are listed in default preference order.

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.

To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.

Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.

Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.

Unique identifier for a matchmaking configuration. This name is used to
identify the configuration associated with a matchmaking request or
ticket.

:description(String)
—

Meaningful description of the matchmaking configuration.

:game_session_queue_arns(required, Array<String>)
—

Amazon Resource Name (ARN) that is assigned to a game session queue
and uniquely identifies it. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
These queues are used when placing game sessions for matches that are
created with this matchmaking configuration. Queues can be located in
any region.

:request_timeout_seconds(required, Integer)
—

Maximum duration, in seconds, that a matchmaking ticket can remain in
process before timing out. Requests that time out can be resubmitted as
needed.

:acceptance_timeout_seconds(Integer)
—

Length of time (in seconds) to wait for players to accept a proposed
match. If any player rejects the match or fails to accept before the
timeout, the ticket continues to look for an acceptable match.

:acceptance_required(required, Boolean)
—

Flag that determines whether or not a match that was created with this
configuration must be accepted by the matched players. To require
acceptance, set to TRUE.

:rule_set_name(required, String)
—

Unique identifier for a matchmaking rule set to use with this
configuration. A matchmaking configuration can only use rule sets that
are defined in the same region.

:notification_target(String)
—

SNS topic ARN that is set up to receive matchmaking notifications.

:additional_player_count(Integer)
—

Number of player slots in a match to keep open for future players. For
example, if the configuration\'s rule set specifies a match for a single
12-person team, and the additional player count is set to 2, only 10
players are selected for the match.

:custom_event_data(String)
—

Information to attached to all events related to the matchmaking
configuration.

Set of custom properties for a game session, formatted as key:value
pairs. These properties are passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session). This information is added to the new
GameSession object that is created for a successful match.

:game_session_data(String)
—

Set of custom game session properties, formatted as a single string
value. This data is passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session). This information is added to the new
GameSession object that is created for a successful match.

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, and sets the parameters for acceptable player matches, such as minimum skill level or character type. Rule sets are used in matchmaking configurations, which define how matchmaking requests are handled. Each MatchmakingConfiguration uses one rule set; you can set up multiple rule sets to handle the scenarios that suit your game (such as for different game modes), and create a separate matchmaking configuration for each rule set. See additional information on rule set content in the MatchmakingRuleSet structure. For help creating rule sets, including useful examples, see the topic Adding FlexMatch to Your Game.

Once created, matchmaking rule sets cannot be changed or deleted, so we recommend checking the rule set syntax using ValidateMatchmakingRuleSet before creating the rule set.

To create a matchmaking rule set, provide the set of rules and a unique name. Rule sets must be defined in the same region as the matchmaking configuration they will be used with. Rule sets cannot be edited or deleted. If you need to change a rule set, create a new one with the necessary edits and then update matchmaking configurations to use the new rule set.

Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions.

To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new PlayerSession object is returned. Player sessions cannot be updated.

Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession.

To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new PlayerSession objects is returned. Player sessions cannot be updated.

Map of string pairs, each specifying a player ID and a set of
developer-defined information related to the player. Amazon GameLift
does not use this data, so it can be formatted as needed for use in the
game. Player data strings for player IDs not included in the PlayerIds
parameter are ignored.

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 AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.

Unique identifier for the AWS account that you use to manage your Amazon
GameLift fleet. You can find your Account ID in the AWS Management
Console under account settings.

:peer_vpc_id(required, String)
—

Unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same region where your fleet is
deployed. To get VPC information, including IDs, use the Virtual Private
Cloud service tools, including the VPC Dashboard in the AWS Management
Console.

#create_vpc_peering_connection(options = {}) ⇒ Struct

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS 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 call 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 AWS 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 AWS 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 VpcPeeringConnection 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.

Unique identifier for a fleet. This tells Amazon GameLift which GameLift
VPC to peer with.

:peer_vpc_aws_account_id(required, String)
—

Unique identifier for the AWS account with the VPC that you want to peer
your Amazon GameLift fleet with. You can find your Account ID in the AWS
Management Console under account settings.

:peer_vpc_id(required, String)
—

Unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same region where your fleet is
deployed. To get VPC information, including IDs, use the Virtual Private
Cloud service tools, including the VPC Dashboard in the AWS Management
Console.

#delete_alias(options = {}) ⇒ Struct

Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

#delete_matchmaking_configuration(options = {}) ⇒ 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.

#delete_scaling_policy(options = {}) ⇒ Struct

Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet.

Unique identifier for the AWS account that you use to manage your Amazon
GameLift fleet. You can find your Account ID in the AWS Management
Console under account settings.

:peer_vpc_id(required, String)
—

Unique identifier for a VPC with resources to be accessed by your Amazon
GameLift fleet. The VPC must be in the same region where your fleet is
deployed. To get VPC information, including IDs, use the Virtual Private
Cloud service tools, including the VPC Dashboard in the AWS Management
Console.

Once a valid authorization exists, call this operation from the AWS 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.

Name of an EC2 instance type that is supported in Amazon GameLift. A
fleet instance type determines the computing resources of each instance
in the fleet, including CPU, memory, storage, and networking capacity.
Amazon GameLift supports the following EC2 instance types. See Amazon
EC2 Instance Types for detailed descriptions. Leave this parameter
blank to retrieve limits for all types.

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Unique identifier for a fleet(s) to retrieve attributes for. To request
attributes for all fleets, leave this parameter empty.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. This parameter is ignored
when the request specifies one or a list of fleet IDs.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value. This
parameter is ignored when the request specifies one or a list of fleet
IDs.

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Unique identifier for a fleet(s) to retrieve capacity information for.
To request capacity information for all fleets, leave this parameter
empty.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. This parameter is ignored
when the request specifies one or a list of fleet IDs.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value. This
parameter is ignored when the request specifies one or a list of fleet
IDs.

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Earliest date to retrieve event logs for. If no start time is specified,
this call returns entries starting from when the fleet was created to
the specified end time. Format is a number expressed in Unix time as
milliseconds (ex: \"1469498468.057\").

:end_time(Time)
—

Most recent date to retrieve event logs for. If no end time is
specified, this call returns entries from the specified start time up to
the present. Format is a number expressed in Unix time as milliseconds
(ex: \"1469498468.057\").

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Unique identifier for a fleet(s) to retrieve utilization data for. To
request utilization data for all fleets, leave this parameter empty.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. This parameter is ignored
when the request specifies one or a list of fleet IDs.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value. This
parameter is ignored when the request specifies one or a list of fleet
IDs.

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

Unique identifier for a fleet to retrieve all game sessions active on
the fleet.

:game_session_id(String)
—

Unique identifier for the game session to retrieve.

:alias_id(String)
—

Unique identifier for an alias associated with the fleet to retrieve all
game sessions for.

:status_filter(String)
—

Game session status to filter results on. Possible game session statuses
include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last
two are transitory).

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

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. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region.

List of queue names to retrieve information for. To request settings for
all queues, leave this parameter empty.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.

Unique identifier for the game session to retrieve. You can use either a
GameSessionId or GameSessionArn value.

:alias_id(String)
—

Unique identifier for an alias associated with the fleet to retrieve all
game sessions for.

:status_filter(String)
—

Game session status to filter results on. Possible game session statuses
include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the
last two are transitory).

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

Unique identifier for an instance to retrieve. Specify an instance ID or
leave blank to retrieve all instances in the fleet.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking.

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.

Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, 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.

Unique identifier for a matchmaking configuration(s) to retrieve. To
request all existing configurations, leave this parameter empty.

:rule_set_name(String)
—

Unique identifier for a matchmaking rule set. Use this parameter to
retrieve all matchmaking configurations that use this rule set.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. This parameter is limited
to 10.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

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.

Unique identifier for a matchmaking rule set. This name is used to
identify the rule set associated with a matchmaking configuration.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Unique identifier for the game session to retrieve player sessions for.

:player_id(String)
—

Unique identifier for a player to retrieve player sessions for.

:player_session_id(String)
—

Unique identifier for a player session to retrieve.

:player_session_status_filter(String)
—

Player session status to filter results on.

Possible player session statuses include the following:

RESERVED -- The player session request has been received, but the
player has not yet connected to the server process and/or been
validated.

ACTIVE -- The player has been validated by the server process and
is currently connected.

COMPLETED -- The player connection has been dropped.

TIMEDOUT -- A player session request was received, but the player
did not connect and/or was not validated within the timeout limit (60
seconds).

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. If a player session ID is
specified, this parameter is ignored.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value. If a
player session ID is specified, this parameter is ignored.

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 (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

Scaling policy status to filter results on. A scaling policy is only in
force when in an ACTIVE status.

ACTIVE -- The scaling policy is currently in force.

UPDATEREQUESTED -- A request to update the scaling policy has been
received.

UPDATING -- A change is being made to the scaling policy.

DELETEREQUESTED -- A request to delete the scaling policy has been
received.

DELETING -- The scaling policy is being deleted.

DELETED -- The scaling policy has been deleted.

ERROR -- An error occurred in creating the policy. It should be
removed and recreated.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.

To request access to a specific instance, specify the IDs of the instance and the fleet it belongs to. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.

Unique identifier for a fleet that contains the instance you want access
to. The fleet can be in any of the following statuses: ACTIVATING,
ACTIVE, or ERROR. Fleets with an ERROR status may be accessible
for a short time before they are deleted.

:instance_id(required, String)
—

Unique identifier for an instance you want to get access to. You can
access an instance in any status.

Type of routing to filter results on. Use this parameter to retrieve
only aliases of a certain type. To retrieve all aliases, leave this
parameter empty.

Possible routing types include the following:

SIMPLE -- The alias resolves to one specific fleet. Use this type
when routing to active fleets.

TERMINAL -- The alias does not resolve to a fleet but instead can
be used to display a message to the user. A terminal alias throws a
TerminalRoutingStrategyException with the RoutingStrategy
message embedded.

:name(String)
—

Descriptive label that is associated with an alias. Alias names do not
need to be unique.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

INITIALIZED -- A new build has been defined, but no files have
been uploaded. You cannot create fleets for builds that are in this
status. When a build is successfully created, the build status is set
to this value.

READY -- The game build has been successfully uploaded. You can
now create new fleets for this build.

FAILED -- The game build upload failed. You cannot create new
fleets for this build.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Unique identifier for a build to return fleets for. Use this parameter
to return only fleets using the specified build. To retrieve all fleets,
leave this parameter empty.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator][Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold][20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

ExactCapacity -- set the instance count to the scaling adjustment
value.

PercentChangeInCapacity -- increase or reduce the current instance
count by the scaling adjustment, read as a percentage. Positive values
scale up while negative values scale down; for example, a value of
\"-10\" scales the fleet down by 10%.

:threshold(Float)
—

Metric value used to trigger a scaling event.

:comparison_operator(String)
—

Comparison operator to use when measuring the metric against the
threshold value.

:evaluation_periods(Integer)
—

Length of time (in minutes) the metric must be at or beyond the
threshold before a scaling event is triggered.

ActivatingGameSessions -- Game sessions in the process of being
created.

ActiveGameSessions -- Game sessions that are currently running.

ActiveInstances -- Fleet instances that are currently running at
least one game session.

AvailableGameSessions -- Additional game sessions that fleet could
host simultaneously, given current capacity.

AvailablePlayerSessions -- Empty player slots in currently active
game sessions. This includes game sessions that are not currently
accepting players. Reserved player slots are not included.

CurrentPlayerSessions -- Player slots in active game sessions that
are being used by a player or are reserved for a player.

IdleInstances -- Active instances that are currently hosting zero
game sessions.

PercentAvailableGameSessions -- Unused percentage of the total
number of game sessions that a fleet could host simultaneously, given
current capacity. Use this metric for a target-based scaling policy.

PercentIdleInstances -- Percentage of the total number of active
instances that are hosting zero game sessions.

QueueDepth -- Pending game session placement requests, in any
queue, where the current fleet is the top-priority destination.

WaitTime -- Current wait time for pending game session placement
requests, in any queue, where the current fleet is the top-priority
destination.

:policy_type(String)
—

Type of scaling policy to create. For a target-based policy, set the
parameter MetricName to \'PercentAvailableGameSessions\' and specify a
TargetConfiguration. For a rule-based policy set the following
parameters: MetricName, ComparisonOperator, Threshold,
EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:

gameSessionId -- Unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.

gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.

gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair "gameMode:brawl", specify the following: gameSessionProperties.gameMode = "brawl". All custom data values are searched as strings.

maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.

creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.

playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.

hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.

You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails.

Value -- Value to be searched for. Values may be numbers, boolean
values (true/false) or strings depending on the operand. String values
are case sensitive and must be enclosed in single quotes. Special
characters must be escaped. Boolean and string values can only be used
with the comparators = and <>. For example, the following filter
expression searches on gameSessionName: \"FilterExpression":
"gameSessionName = 'Matt\\'s Awesome Game 1'".

To chain multiple conditions in a single expression, use the logical
keywords AND, OR, and NOT and parentheses as needed. For example:
x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the
following precedence rules:

=, <>, <, >, <=, >=

Parentheses

NOT

AND

OR

For example, this filter expression retrieves game sessions hosting at
least ten players that have an open player slot: "maximumSessions>=10
AND hasAvailablePlayerSessions=true".

:sort_expression(String)
—

Instructions on how to sort the search results. If no sort expression is
included, the request returns results in random order. A sort expression
consists of the following elements:

For example, this sort expression returns the oldest active sessions
first: "SortExpression": "creationTimeMillis ASC". Results with a null
value for the sort operand are returned at the end of the list.

:limit(Integer)
—

Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. The maximum number of
results returned is 20, even if this value is not set or is set higher
than 20.

:next_token(String)
—

Token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this action. To
start at the beginning of the result set, do not specify a value.

#start_fleet_actions(options = {}) ⇒ Struct

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

The queue name and a set of game session properties and settings

A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request

(Optional) A set of IDs and player data for each player you want to join to the new game session

Latency data for all players (if you want to optimize game play for the players)

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

Unique identifier to assign to the new game session placement. This
value is developer-defined. The value must be unique across all regions
and cannot be reused unless you are resubmitting a canceled or timed-out
placement request.

Set of custom properties for a game session, formatted as key:value
pairs. These properties are passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session).

:maximum_player_session_count(required, Integer)
—

Maximum number of players that can be connected simultaneously to the
game session.

:game_session_name(String)
—

Descriptive label that is associated with a game session. Session names
do not need to be unique.

Set of values, expressed in milliseconds, indicating the amount of
latency that a player experiences when connected to AWS regions. This
information is used to try to place the new game session where it can
offer the best possible gameplay experience for the players.

Set of custom game session properties, formatted as a single string
value. This data is passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session).

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch.

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works.

Unique identifier for a matchmaking ticket. If no ticket ID is specified
here, Amazon GameLift will generate one in the form of a UUID. Use this
identifier to track the match backfill ticket status and retrieve match
results.

:configuration_name(required, String)
—

Name of the matchmaker to use for this request. The name of the
matchmaker that was used with the original game session is listed in the
GameSession object, MatchmakerData property. This property
contains a matchmaking configuration ARN value, which includes the
matchmaker name. (In the ARN value
\"arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4\",
the matchmaking configuration name is \"MM-4v4\".) Use only the name for
this parameter.

:game_session_arn(required, String)
—

Amazon Resource Name (ARN) that is assigned to a game session and
uniquely identifies it.

Match information on all players that are currently assigned to the game
session. This information is used by the matchmaker to find new players
and add them to the existing game.

PlayerID, PlayerAttributes, Team -\\- This information is maintained
in the GameSession object, MatchmakerData property, for all
players who are currently assigned to the game session. The matchmaker
data is in JSON syntax, formatted as a string. For more details, see
Match Data.

LatencyInMs -\\- If the matchmaker uses player latency, include a
latency value, in milliseconds, for the region that the game session
is currently in. Do not include latency values for any other region.

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration. For complete information on setting up and using FlexMatch, see the topic Adding FlexMatch to Your Game.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches.

Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests:

Polling -- Call DescribeMatchmaking. This operation returns the full ticket object, including current status and (for completed tickets) game session connection info. We recommend polling no more than once every 10 seconds.

Notifications -- Get event notifications for changes in ticket status using Amazon Simple Notification Service (SNS). Notifications are easy to set up (see CreateMatchmakingConfiguration) and typically deliver match status changes faster and more efficiently than polling. We recommend that you use polling to back up to notifications (since delivery is not guaranteed) and call DescribeMatchmaking only when notifications are not received within 30 seconds.

Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket.

FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status.

If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details).

Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data.

When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game.

Unique identifier for a matchmaking ticket. If no ticket ID is specified
here, Amazon GameLift will generate one in the form of a UUID. Use this
identifier to track the matchmaking ticket status and retrieve match
results.

:configuration_name(required, String)
—

Name of the matchmaking configuration to use for this request.
Matchmaking configurations must exist in the same region as this
request.

Information on each player to be matched. This information must include
a player ID, and may contain player attributes and latency data to be
used in the matchmaking process. After a successful match, Player
objects contain the name of the team the player is assigned to.

#stop_fleet_actions(options = {}) ⇒ Struct

Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity.

#stop_matchmaking(options = {}) ⇒ Struct

Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

Descriptive label that is associated with a fleet. Fleet names do not
need to be unique.

:description(String)
—

Human-readable description of a fleet.

:new_game_session_protection_policy(String)
—

Game session protection policy to apply to all new instances created in
this fleet. Instances that already exist are not affected. You can set
protection for individual instances using UpdateGameSession.

NoProtection -- The game session can be terminated during a
scale-down event.

FullProtection -- If the game session is in an ACTIVE status, it
cannot be terminated during a scale-down event.

Policy that limits the number of game sessions an individual player can
create over a span of time.

:metric_groups(Array<String>)
—

Names of metric groups to include this fleet in. Amazon CloudWatch uses
a fleet metric group is to aggregate metrics from multiple fleets. Use
an existing metric group name to add this fleet to the group. Or use a
new name to create a new metric group. A fleet can only be included in
one metric group at a time.

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs.

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Collection of latency policies to apply when processing game sessions
placement requests with player latency information. Multiple policies
are evaluated in order of the maximum latency value, starting with the
lowest latency values. With just one policy, it is enforced at the start
of the game session placement for the duration period. With multiple
policies, each policy is enforced consecutively for its duration period.
For example, a queue might enforce a 60-second policy followed by a
120-second policy, and then no policy for the remainder of the
placement. When updating policies, provide a complete collection of
policies.

List of fleets that can be used to fulfill game session placement
requests in the queue. Fleets are identified by either a fleet ARN or a
fleet alias ARN. Destinations are listed in default preference order.
When updating this list, provide a complete list of destinations.

Amazon Resource Name (ARN) that is assigned to a game session queue
and uniquely identifies it. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
These queues are used when placing game sessions for matches that are
created with this matchmaking configuration. Queues can be located in
any region.

:request_timeout_seconds(Integer)
—

Maximum duration, in seconds, that a matchmaking ticket can remain in
process before timing out. Requests that time out can be resubmitted as
needed.

:acceptance_timeout_seconds(Integer)
—

Length of time (in seconds) to wait for players to accept a proposed
match. If any player rejects the match or fails to accept before the
timeout, the ticket continues to look for an acceptable match.

:acceptance_required(Boolean)
—

Flag that determines whether or not a match that was created with this
configuration must be accepted by the matched players. To require
acceptance, set to TRUE.

:rule_set_name(String)
—

Unique identifier for a matchmaking rule set to use with this
configuration. A matchmaking configuration can only use rule sets that
are defined in the same region.

Number of player slots in a match to keep open for future players. For
example, if the configuration\'s rule set specifies a match for a single
12-person team, and the additional player count is set to 2, only 10
players are selected for the match.

:custom_event_data(String)
—

Information to attached to all events related to the matchmaking
configuration.

Set of custom properties for a game session, formatted as key:value
pairs. These properties are passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session). This information is added to the new
GameSession object that is created for a successful match.

:game_session_data(String)
—

Set of custom game session properties, formatted as a single string
value. This data is passed to a game server process in the
GameSession object with a request to start a new game session
(see Start a Game Session). This information is added to the new
GameSession object that is created for a successful match.

Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.

Instructions for launching server processes on each instance in the
fleet. The run-time configuration for a fleet has a collection of server
process configurations, one for each type of server process to run on an
instance. A server process configuration specifies the location of the
server executable, launch parameters, and the number of concurrent
processes with that configuration to maintain on each instance.

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set uses syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set string.