You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.GameLift

Inherits:
AWS.Service show all
Identifier:
gamelift
API Version:
2015-10-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on AWS global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.

About GameLift solutions

Get more information on these GameLift solutions in the GameLift Developer Guide.

  • GameLift managed hosting -- GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.

  • Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core GameLift infrastructure already built in. Then use the full range of GameLift managed hosting features, including FlexMatch, for your game.

  • GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.

  • GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.

About this API Reference

This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the AWS CLI reference. Useful links:

Sending a Request Using GameLift

var gamelift = new AWS.GameLift();
gamelift.acceptMatch(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the GameLift object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var gamelift = new AWS.GameLift({apiVersion: '2015-10-01'});

You can also set the API version globally in AWS.config.apiVersions using the gamelift service identifier:

AWS.config.apiVersions = {
  gamelift: '2015-10-01',
  // other service API versions
};

var gamelift = new AWS.GameLift();

Version:

  • 2015-10-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.GameLift(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a GameLift object

var gamelift = new AWS.GameLift({apiVersion: '2015-10-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.GameLift.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.GameLift.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.GameLift.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptMatch(params = {}, callback) ⇒ AWS.Request

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

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

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

Learn more

Add FlexMatch to a game client

FlexMatch events (reference)

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Service Reference:

Examples:

Calling the acceptMatch operation

var params = {
  AcceptanceType: ACCEPT | REJECT, /* required */
  PlayerIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TicketId: 'STRING_VALUE' /* required */
};
gamelift.acceptMatch(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TicketId — (String)

      A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

    • PlayerIds — (Array<String>)

      A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

    • AcceptanceType — (String)

      Player response to the proposed match.

      Possible values include:
      • "ACCEPT"
      • "REJECT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

claimGameServer(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Locates an available game server and temporarily reserves it to host gameplay and players. This operation is called from a game client or client service (such as a matchmaker) to request hosting resources for a new game session. In response, GameLift FleetIQ locates an available game server, places it in CLAIMED status for 60 seconds, and returns connection information that players can use to connect to the game server.

To claim a game server, identify a game server group. You can also specify a game server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally, include game data to pass to the game server at the start of a game session, such as a game map or player information.

When a game server is successfully claimed, connection information is returned. A claimed game server's utilization status remains AVAILABLE while the claim status is set to CLAIMED for up to 60 seconds. This time period gives the game server time to update its status to UTILIZED (using UpdateGameServer) once 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.

Note: When claiming a specific game server, this request will succeed even if the game server is running on an instance in DRAINING status. To avoid this, first check the instance status by calling DescribeGameServerInstances.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Service Reference:

Examples:

Calling the claimGameServer operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  GameServerData: 'STRING_VALUE',
  GameServerId: 'STRING_VALUE'
};
gamelift.claimGameServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim.

    • GameServerId — (String)

      A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available game server in the specified game server group.

    • GameServerData — (String)

      A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServer — (map)

        Object that describes the newly claimed game server.

        • GameServerGroupName — (String)

          A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

        • GameServerGroupArn — (String)

          The ARN identifier for the game server group where the game server is located.

        • GameServerId — (String)

          A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

        • InstanceId — (String)

          The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

        • ConnectionInfo — (String)

          The port and IP address that must be used to establish a client connection to the game server.

        • GameServerData — (String)

          A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

        • ClaimStatus — (String)

          Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

          Possible values include:
          • "CLAIMED"
        • UtilizationStatus — (String)

          Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

          • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

          • UTILIZED - The game server is currently hosting a game session with players.

          Possible values include:
          • "AVAILABLE"
          • "UTILIZED"
        • RegistrationTime — (Date)

          Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastClaimTime — (Date)

          Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

        • LastHealthCheckTime — (Date)

          Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAlias(params = {}, callback) ⇒ AWS.Request

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

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Service Reference:

Examples:

Calling the createAlias operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RoutingStrategy: { /* required */
    FleetId: 'STRING_VALUE',
    Message: 'STRING_VALUE',
    Type: SIMPLE | TERMINAL
  },
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
gamelift.createAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

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

    • Description — (String)

      A human-readable description of the alias.

    • RoutingStrategy — (map)

      The routing configuration, including routing type and fleet target, for the alias.

      • Type — (String)

        The type of routing strategy for the alias.

        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.

        Possible values include:
        • "SIMPLE"
        • "TERMINAL"
      • FleetId — (String)

        A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

      • Message — (String)

        The message text to be used with a terminal routing strategy.

    • Tags — (Array<map>)

      A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Alias — (map)

        The newly created alias resource.

        • AliasId — (String)

          A unique identifier for the alias. Alias IDs are unique within a Region.

        • Name — (String)

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

        • AliasArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

        • Description — (String)

          A human-readable description of an alias.

        • RoutingStrategy — (map)

          The routing configuration, including routing type and fleet target, for the alias.

          • Type — (String)

            The type of routing strategy for the alias.

            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.

            Possible values include:
            • "SIMPLE"
            • "TERMINAL"
          • FleetId — (String)

            A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

          • Message — (String)

            The message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBuild(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon GameLift build resource for your game server binary files. Game server binaries must be combined into a zip file for use with Amazon GameLift.

When setting up a new game build for GameLift, we recommend using the AWS CLI command upload-build . This helper command combines two tasks: (1) it uploads your build files from a file directory to a GameLift Amazon S3 location, and (2) it creates a new build resource.

The CreateBuild operation can used in the following scenarios:

  • To create a new game build with build files that are in an Amazon S3 location under an AWS account that you control. To use this option, you must first give Amazon GameLift access to the Amazon S3 bucket. With permissions in place, call CreateBuild and specify a build name, operating system, and the Amazon S3 storage location of your game build.

  • To directly upload your build files to a GameLift Amazon S3 location. To use this option, first call CreateBuild and specify a build name and operating system. This operation creates a new build resource and also returns an Amazon S3 location with temporary access credentials. Use the credentials to manually upload your build files to the specified Amazon S3 location. For more information, see Uploading Objects in the Amazon S3 Developer Guide. Build files can be uploaded to the GameLift Amazon S3 location once only; that can't be updated.

If successful, this operation creates a new build resource with a unique build ID and places it in INITIALIZED status. A build must be in READY status before you can create fleets with it.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

Service Reference:

Examples:

Calling the createBuild operation

var params = {
  Name: 'STRING_VALUE',
  OperatingSystem: WINDOWS_2012 | AMAZON_LINUX | AMAZON_LINUX_2,
  StorageLocation: {
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE',
    ObjectVersion: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Version: 'STRING_VALUE'
};
gamelift.createBuild(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

    • Version — (String)

      Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

    • StorageLocation — (map)

      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. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your new build must be in the same Region.

      • Bucket — (String)

        An Amazon S3 bucket identifier. This is the name of the S3 bucket.

        Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
      • Key — (String)

        The name of the zip file that contains the build files or script files.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

      • ObjectVersion — (String)

        The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

    • OperatingSystem — (String)

      The 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.

      Possible values include:
      • "WINDOWS_2012"
      • "AMAZON_LINUX"
      • "AMAZON_LINUX_2"
    • Tags — (Array<map>)

      A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Build — (map)

        The newly created build resource, including a unique build IDs and status.

        • BuildId — (String)

          A unique identifier for the build.

        • BuildArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

        • Name — (String)

          A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

        • Status — (String)

          Current status of the build.

          Possible build statuses include the following:

          • 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.

          Possible values include:
          • "INITIALIZED"
          • "READY"
          • "FAILED"
        • SizeOnDisk — (Integer)

          File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

        • OperatingSystem — (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.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      • UploadCredentials — (map)

        This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.

        • AccessKeyId — (String)

          Temporary key allowing access to the Amazon GameLift S3 account.

        • SecretAccessKey — (String)

          Temporary secret key allowing access to the Amazon GameLift S3 account.

        • SessionToken — (String)

          Token used to associate a specific build ID with the files uploaded using these credentials.

      • StorageLocation — (map)

        Amazon S3 location for your game build file, including bucket name and key.

        • Bucket — (String)

          An Amazon S3 bucket identifier. This is the name of the S3 bucket.

          Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
        • Key — (String)

          The name of the zip file that contains the build files or script files.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

        • ObjectVersion — (String)

          The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFleet(params = {}, callback) ⇒ AWS.Request

Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.

Most GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following AWS Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other GameLift Regions can deploy instances in the fleet's home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.

To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.

If successful, this operation creates a new Fleet resource and places it in NEW status, which prompts GameLift to initiate the fleet creation workflow. You can track fleet creation by checking fleet status using DescribeFleetAttributes and DescribeFleetLocationAttributes/, or by monitoring fleet creation events using DescribeFleetEvents. As soon as the fleet status changes to ACTIVE, you can enable automatic scaling for the fleet with PutScalingPolicy and set capacity for the home Region with UpdateFleetCapacity. When the status of each remote location reaches ACTIVE, you can set capacity by location using UpdateFleetCapacity.

Learn more

Setting up fleets

Debug fleet creation issues

Multi-location fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  EC2InstanceType: t2.micro | t2.small | t2.medium | t2.large | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge, /* required */
  Name: 'STRING_VALUE', /* required */
  BuildId: 'STRING_VALUE',
  CertificateConfiguration: {
    CertificateType: DISABLED | GENERATED /* required */
  },
  Description: 'STRING_VALUE',
  EC2InboundPermissions: [
    {
      FromPort: 'NUMBER_VALUE', /* required */
      IpRange: 'STRING_VALUE', /* required */
      Protocol: TCP | UDP, /* required */
      ToPort: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  FleetType: ON_DEMAND | SPOT,
  InstanceRoleArn: 'STRING_VALUE',
  Locations: [
    {
      Location: 'STRING_VALUE'
    },
    /* more items */
  ],
  LogPaths: [
    'STRING_VALUE',
    /* more items */
  ],
  MetricGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  NewGameSessionProtectionPolicy: NoProtection | FullProtection,
  PeerVpcAwsAccountId: 'STRING_VALUE',
  PeerVpcId: 'STRING_VALUE',
  ResourceCreationLimitPolicy: {
    NewGameSessionsPerCreator: 'NUMBER_VALUE',
    PolicyPeriodInMinutes: 'NUMBER_VALUE'
  },
  RuntimeConfiguration: {
    GameSessionActivationTimeoutSeconds: 'NUMBER_VALUE',
    MaxConcurrentGameSessionActivations: 'NUMBER_VALUE',
    ServerProcesses: [
      {
        ConcurrentExecutions: 'NUMBER_VALUE', /* required */
        LaunchPath: 'STRING_VALUE', /* required */
        Parameters: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  ScriptId: 'STRING_VALUE',
  ServerLaunchParameters: 'STRING_VALUE',
  ServerLaunchPath: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
gamelift.createFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

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

    • Description — (String)

      A human-readable description of the fleet.

    • BuildId — (String)

      The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to GameLift and in READY status. This fleet property cannot be changed later.

    • ScriptId — (String)

      The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift prior to creating the fleet. This fleet property cannot be changed later.

    • ServerLaunchPath — (String)

      This parameter is no longer used. Specify a server launch path using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

    • ServerLaunchParameters — (String)

      This parameter is no longer used. Specify server launch parameters using the RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

    • LogPaths — (Array<String>)

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

    • EC2InstanceType — (String)

      The GameLift-supported EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions of EC2 instance types.

      Possible values include:
      • "t2.micro"
      • "t2.small"
      • "t2.medium"
      • "t2.large"
      • "c3.large"
      • "c3.xlarge"
      • "c3.2xlarge"
      • "c3.4xlarge"
      • "c3.8xlarge"
      • "c4.large"
      • "c4.xlarge"
      • "c4.2xlarge"
      • "c4.4xlarge"
      • "c4.8xlarge"
      • "c5.large"
      • "c5.xlarge"
      • "c5.2xlarge"
      • "c5.4xlarge"
      • "c5.9xlarge"
      • "c5.12xlarge"
      • "c5.18xlarge"
      • "c5.24xlarge"
      • "c5a.large"
      • "c5a.xlarge"
      • "c5a.2xlarge"
      • "c5a.4xlarge"
      • "c5a.8xlarge"
      • "c5a.12xlarge"
      • "c5a.16xlarge"
      • "c5a.24xlarge"
      • "r3.large"
      • "r3.xlarge"
      • "r3.2xlarge"
      • "r3.4xlarge"
      • "r3.8xlarge"
      • "r4.large"
      • "r4.xlarge"
      • "r4.2xlarge"
      • "r4.4xlarge"
      • "r4.8xlarge"
      • "r4.16xlarge"
      • "r5.large"
      • "r5.xlarge"
      • "r5.2xlarge"
      • "r5.4xlarge"
      • "r5.8xlarge"
      • "r5.12xlarge"
      • "r5.16xlarge"
      • "r5.24xlarge"
      • "r5a.large"
      • "r5a.xlarge"
      • "r5a.2xlarge"
      • "r5a.4xlarge"
      • "r5a.8xlarge"
      • "r5a.12xlarge"
      • "r5a.16xlarge"
      • "r5a.24xlarge"
      • "m3.medium"
      • "m3.large"
      • "m3.xlarge"
      • "m3.2xlarge"
      • "m4.large"
      • "m4.xlarge"
      • "m4.2xlarge"
      • "m4.4xlarge"
      • "m4.10xlarge"
      • "m5.large"
      • "m5.xlarge"
      • "m5.2xlarge"
      • "m5.4xlarge"
      • "m5.8xlarge"
      • "m5.12xlarge"
      • "m5.16xlarge"
      • "m5.24xlarge"
      • "m5a.large"
      • "m5a.xlarge"
      • "m5a.2xlarge"
      • "m5a.4xlarge"
      • "m5a.8xlarge"
      • "m5a.12xlarge"
      • "m5a.16xlarge"
      • "m5a.24xlarge"
    • EC2InboundPermissions — (Array<map>)

      The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift automatically sets TCP and UDP ranges.

      • FromPortrequired — (Integer)

        A starting value for a range of allowed port numbers.

      • ToPortrequired — (Integer)

        An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

      • IpRangerequired — (String)

        A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".

      • Protocolrequired — (String)

        The network communication protocol used by the fleet.

        Possible values include:
        • "TCP"
        • "UDP"
    • NewGameSessionProtectionPolicy — (String)

      The status of termination protection for active game sessions on the fleet. By default, this property is set to NoProtection. You can also set game session protection for an individual game session by calling UpdateGameSession.

      • NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.

      • FullProtection - Game sessions in ACTIVE status cannot be terminated during a scale-down event.

      Possible values include:
      • "NoProtection"
      • "FullProtection"
    • RuntimeConfiguration — (map)

      Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.

      Note: The RuntimeConfiguration parameter is required unless the fleet is being configured using the older parameters ServerLaunchPath and ServerLaunchParameters, which are still supported for backward compatibility.
      • ServerProcesses — (Array<map>)

        A collection of server process configurations that identify what server processes to run on each instance in a fleet.

        • LaunchPathrequired — (String)

          The location of a game build executable or the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

          • Windows (custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

          • Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

        • Parameters — (String)

          An optional list of parameters to pass to the server executable or Realtime script on launch.

        • ConcurrentExecutionsrequired — (Integer)

          The number of server processes using this configuration that run concurrently on each instance.

      • MaxConcurrentGameSessionActivations — (Integer)

        The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

      • GameSessionActivationTimeoutSeconds — (Integer)

        The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

    • ResourceCreationLimitPolicy — (map)

      A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

      • NewGameSessionsPerCreator — (Integer)

        The maximum number of game sessions that an individual can create during the policy period.

      • PolicyPeriodInMinutes — (Integer)

        The time span used in evaluating the resource creation limit policy.

    • MetricGroups — (Array<String>)

      The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.

    • PeerVpcAwsAccountId — (String)

      Used when peering your GameLift fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.

    • PeerVpcId — (String)

      A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

    • FleetType — (String)

      Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.

      Possible values include:
      • "ON_DEMAND"
      • "SPOT"
    • InstanceRoleArn — (String)

      A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server. This property cannot be changed after the fleet is created.

    • CertificateConfiguration — (map)

      Prompts GameLift to generate a TLS/SSL certificate for the fleet. TLS certificates are used for encrypting traffic between game clients and the game servers that are running on GameLift. By default, the CertificateConfiguration is set to DISABLED. Learn more at Securing Client/Server Communication. This property cannot be changed after the fleet is created.

      Note: This feature requires the AWS Certificate Manager (ACM) service, which is not available in all AWS regions. When working in a region that does not support this feature, a fleet creation request with certificate generation fails with a 4xx error.

      • CertificateTyperequired — (String)

        Indicates whether a TLS/SSL certificate is generated for a fleet.

        Valid values include:

        • GENERATED - Generate a TLS/SSL certificate for this fleet.

        • DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.

        Possible values include:
        • "DISABLED"
        • "GENERATED"
    • Locations — (Array<map>)

      A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in AWS Regions that support multiple locations. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2. To create a fleet with instances in the home Region only, omit this parameter.

      • Location — (String)

        An AWS Region code, such as us-west-2.

    • Tags — (Array<map>)

      A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the fleet is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetAttributes — (map)

        The properties for the new fleet, including the current status. All fleets are placed in NEW status on creation.

        • FleetId — (String)

          A unique identifier for the fleet.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

        • FleetType — (String)

          The kind of instances, On-Demand or Spot, that this fleet uses.

          Possible values include:
          • "ON_DEMAND"
          • "SPOT"
        • InstanceType — (String)

          The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

          Possible values include:
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
        • Description — (String)

          A human-readable description of the fleet.

        • Name — (String)

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

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Status — (String)

          Current status of the fleet. Possible fleet statuses include the following:

          • NEW -- A new fleet has been defined and desired instances is set to 1.

          • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

          • ACTIVE -- Hosts can now accept game sessions.

          • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

          • DELETING -- Hosts are responding to a delete fleet request.

          • TERMINATED -- The fleet no longer exists.

          Possible values include:
          • "NEW"
          • "DOWNLOADING"
          • "VALIDATING"
          • "BUILDING"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETING"
          • "ERROR"
          • "TERMINATED"
        • BuildId — (String)

          A unique identifier for the build resource that is deployed on instances in this fleet.

        • BuildArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

        • ScriptId — (String)

          A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

        • ScriptArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

        • ServerLaunchPath — (String)

          This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

        • ServerLaunchParameters — (String)

          This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

        • LogPaths — (Array<String>)

          This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

        • NewGameSessionProtectionPolicy — (String)

          The type of game session protection to set on all new instances that are started in the fleet.

          • 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.

          Possible values include:
          • "NoProtection"
          • "FullProtection"
        • OperatingSystem — (String)

          The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • ResourceCreationLimitPolicy — (map)

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

          • NewGameSessionsPerCreator — (Integer)

            The maximum number of game sessions that an individual can create during the policy period.

          • PolicyPeriodInMinutes — (Integer)

            The time span used in evaluating the resource creation limit policy.

        • MetricGroups — (Array<String>)

          Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

        • StoppedActions — (Array<String>)

          A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

        • InstanceRoleArn — (String)

          A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

        • CertificateConfiguration — (map)

          Indicates whether a TLS/SSL certificate was generated for the fleet.

          • CertificateTyperequired — (String)

            Indicates whether a TLS/SSL certificate is generated for a fleet.

            Valid values include:

            • GENERATED - Generate a TLS/SSL certificate for this fleet.

            • DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.

            Possible values include:
            • "DISABLED"
            • "GENERATED"
      • LocationStates — (Array<map>)

        The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to NEW. During fleet creation, GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.

        • Location — (String)

          The fleet location, expressed as an AWS Region code such as us-west-2.

        • Status — (String)

          The life-cycle status of a fleet location.

          Possible values include:
          • "NEW"
          • "DOWNLOADING"
          • "VALIDATING"
          • "BUILDING"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETING"
          • "ERROR"
          • "TERMINATED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFleetLocations(params = {}, callback) ⇒ AWS.Request

Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.

Note: This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in AWS Regions that support this feature (see CreateFleet for the complete list) and were created after the feature was released in March 2021.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents. Alternatively, you can poll location status by calling DescribeFleetLocationAttributes. After a location status becomes ACTIVE, you can adjust the location's capacity as needed with UpdateFleetCapacity.

Learn more

Setting up fleets

Multi-location fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Service Reference:

Examples:

Calling the createFleetLocations operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Locations: [ /* required */
    {
      Location: 'STRING_VALUE'
    },
    /* more items */
  ]
};
gamelift.createFleetLocations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.

    • Locations — (Array<map>)

      A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported AWS Region as a remote location, in the form of an AWS Region code such as us-west-2.

      • Location — (String)

        An AWS Region code, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that was updated with new locations.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      • LocationStates — (Array<map>)

        The remote locations that are being added to the fleet, and the life-cycle status of each location. For new locations, the status is set to NEW. During location creation, GameLift updates each location's status as instances are deployed there and prepared for game hosting. This list does not include the fleet home Region or any remote locations that were already added to the fleet.

        • Location — (String)

          The fleet location, expressed as an AWS Region code such as us-west-2.

        • Status — (String)

          The life-cycle status of a fleet location.

          Possible values include:
          • "NEW"
          • "DOWNLOADING"
          • "VALIDATING"
          • "BUILDING"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETING"
          • "ERROR"
          • "TERMINATED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGameServerGroup(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

  • An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon EC2 User Guide.

  • An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide.

To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the createGameServerGroup operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  InstanceDefinitions: [ /* required */
    {
      InstanceType: c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge, /* required */
      WeightedCapacity: 'STRING_VALUE'
    },
    /* more items */
  ],
  LaunchTemplate: { /* required */
    LaunchTemplateId: 'STRING_VALUE',
    LaunchTemplateName: 'STRING_VALUE',
    Version: 'STRING_VALUE'
  },
  MaxSize: 'NUMBER_VALUE', /* required */
  MinSize: 'NUMBER_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  AutoScalingPolicy: {
    TargetTrackingConfiguration: { /* required */
      TargetValue: 'NUMBER_VALUE' /* required */
    },
    EstimatedInstanceWarmup: 'NUMBER_VALUE'
  },
  BalancingStrategy: SPOT_ONLY | SPOT_PREFERRED | ON_DEMAND_ONLY,
  GameServerProtectionPolicy: NO_PROTECTION | FULL_PROTECTION,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VpcSubnets: [
    'STRING_VALUE',
    /* more items */
  ]
};
gamelift.createGameServerGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    • MinSize — (Integer)

      The minimum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

    • MaxSize — (Integer)

      The maximum number of instances allowed in the EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

    • LaunchTemplate — (map)

      The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      Note: If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to "true". If no network interface is specified in the launch template, GameLift FleetIQ uses your account's default VPC.
      • LaunchTemplateId — (String)

        A unique identifier for an existing EC2 launch template.

      • LaunchTemplateName — (String)

        A readable identifier for an existing EC2 launch template.

      • Version — (String)

        The version of the EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created.

    • InstanceDefinitions — (Array<map>)

      The EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      • InstanceTyperequired — (String)

        An EC2 instance type designation.

        Possible values include:
        • "c4.large"
        • "c4.xlarge"
        • "c4.2xlarge"
        • "c4.4xlarge"
        • "c4.8xlarge"
        • "c5.large"
        • "c5.xlarge"
        • "c5.2xlarge"
        • "c5.4xlarge"
        • "c5.9xlarge"
        • "c5.12xlarge"
        • "c5.18xlarge"
        • "c5.24xlarge"
        • "c5a.large"
        • "c5a.xlarge"
        • "c5a.2xlarge"
        • "c5a.4xlarge"
        • "c5a.8xlarge"
        • "c5a.12xlarge"
        • "c5a.16xlarge"
        • "c5a.24xlarge"
        • "r4.large"
        • "r4.xlarge"
        • "r4.2xlarge"
        • "r4.4xlarge"
        • "r4.8xlarge"
        • "r4.16xlarge"
        • "r5.large"
        • "r5.xlarge"
        • "r5.2xlarge"
        • "r5.4xlarge"
        • "r5.8xlarge"
        • "r5.12xlarge"
        • "r5.16xlarge"
        • "r5.24xlarge"
        • "r5a.large"
        • "r5a.xlarge"
        • "r5a.2xlarge"
        • "r5a.4xlarge"
        • "r5a.8xlarge"
        • "r5a.12xlarge"
        • "r5a.16xlarge"
        • "r5a.24xlarge"
        • "m4.large"
        • "m4.xlarge"
        • "m4.2xlarge"
        • "m4.4xlarge"
        • "m4.10xlarge"
        • "m5.large"
        • "m5.xlarge"
        • "m5.2xlarge"
        • "m5.4xlarge"
        • "m5.8xlarge"
        • "m5.12xlarge"
        • "m5.16xlarge"
        • "m5.24xlarge"
        • "m5a.large"
        • "m5a.xlarge"
        • "m5a.2xlarge"
        • "m5a.4xlarge"
        • "m5a.8xlarge"
        • "m5a.12xlarge"
        • "m5a.16xlarge"
        • "m5a.24xlarge"
      • WeightedCapacity — (String)

        Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

    • AutoScalingPolicy — (map)

      Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.

      • EstimatedInstanceWarmup — (Integer)

        Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

      • TargetTrackingConfigurationrequired — (map)

        Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

        • TargetValuerequired — (Float)

          Desired value to use with a game server group target-based scaling policy.

    • BalancingStrategy — (String)

      Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

      • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

      • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

      • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

      Possible values include:
      • "SPOT_ONLY"
      • "SPOT_PREFERRED"
      • "ON_DEMAND_ONLY"
    • GameServerProtectionPolicy — (String)

      A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

      Possible values include:
      • "NO_PROTECTION"
      • "FULL_PROTECTION"
    • VpcSubnets — (Array<String>)

      A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.

    • Tags — (Array<map>)

      A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroup — (map)

        The newly created game server group object, including the new ARN value for the GameLift FleetIQ game server group and the object's status. The EC2 Auto Scaling group ARN is initially null, since the group has not yet been created. This value is added once the game server group status reaches ACTIVE.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGameSession(params = {}, callback) ⇒ AWS.Request

Creates a multiplayer game session for players in a specific fleet location. This operation prompts an available server process to start a game session and retrieves connection information for the new game session. As an alternative, consider using the GameLift game session placement feature with

with StartGameSessionPlacement, which uses FleetIQ algorithms and queues to optimize the placement process.

When creating a game session, you specify exactly where you want to place it and provide a set of game session configuration settings. The fleet must be in ACTIVE status before a game session can be created in it.

This operation can be used in the following ways:

  • To create a game session on an instance in a fleet's home Region, provide a fleet or alias ID along with your game session configuration.

  • To create a game session on an instance in a fleet's remote location, provide a fleet or alias ID and a location name, along with your game session configuration.

If successful, a workflow is initiated to start a new game session. A GameSession object is returned containing the game session configuration and status. When the status is ACTIVE, game session connection information is provided and player sessions can be created for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

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

Available in GameLift Local.

Learn more

Start a game session

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the createGameSession operation

var params = {
  MaximumPlayerSessionCount: 'NUMBER_VALUE', /* required */
  AliasId: 'STRING_VALUE',
  CreatorId: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  GameProperties: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  GameSessionData: 'STRING_VALUE',
  GameSessionId: 'STRING_VALUE',
  IdempotencyToken: 'STRING_VALUE',
  Location: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
gamelift.createGameSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

    • AliasId — (String)

      A unique identifier for the alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

    • MaximumPlayerSessionCount — (Integer)

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

    • Name — (String)

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

    • GameProperties — (Array<map>)

      A 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.

      • Keyrequired — (String)

        The game property identifier.

      • Valuerequired — (String)

        The game property value.

    • CreatorId — (String)

      A unique identifier for a player or entity creating the game session. This parameter is required when requesting a new game session on a fleet with a resource creation limit policy. This type of policy limits the number of concurrent active game sessions that one player can create within a certain time span. GameLift uses the CreatorId to evaluate the new request against the policy.

    • GameSessionId — (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.

    • IdempotencyToken — (String)

      Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. 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.

    • GameSessionData — (String)

      A 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.

    • Location — (String)

      A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an AWS Region code such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSession — (map)

        Object that describes the newly created game session record.

        • GameSessionId — (String)

          A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

        • Name — (String)

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

        • FleetId — (String)

          A unique identifier for the fleet that the game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • CurrentPlayerSessionCount — (Integer)

          Number of players currently in the game session.

        • MaximumPlayerSessionCount — (Integer)

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

        • Status — (String)

          Current status of the game session. A game session must have an ACTIVE status to have player sessions.

          Possible values include:
          • "ACTIVE"
          • "ACTIVATING"
          • "TERMINATED"
          • "TERMINATING"
          • "ERROR"
        • StatusReason — (String)

          Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

          Possible values include:
          • "INTERRUPTED"
        • GameProperties — (Array<map>)

          A 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. You can search for active game sessions based on this custom data with SearchGameSessions.

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • PlayerSessionCreationPolicy — (String)

          Indicates whether or not the game session is accepting new players.

          Possible values include:
          • "ACCEPT_ALL"
          • "DENY_ALL"
        • CreatorId — (String)

          A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

        • GameSessionData — (String)

          A 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.

        • MatchmakerData — (String)

          Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

        • Location — (String)

          The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createGameSessionQueue(params = {}, callback) ⇒ AWS.Request

Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and AWS 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 the queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Service Reference:

Examples:

Calling the createGameSessionQueue operation

var params = {
  Name: 'STRING_VALUE', /* required */
  CustomEventData: 'STRING_VALUE',
  Destinations: [
    {
      DestinationArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  FilterConfiguration: {
    AllowedLocations: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  NotificationTarget: 'STRING_VALUE',
  PlayerLatencyPolicies: [
    {
      MaximumIndividualPlayerLatencyMilliseconds: 'NUMBER_VALUE',
      PolicyDurationSeconds: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  PriorityConfiguration: {
    LocationOrder: [
      'STRING_VALUE',
      /* more items */
    ],
    PriorityOrder: [
      LATENCY | COST | DESTINATION | LOCATION,
      /* more items */
    ]
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TimeoutInSeconds: 'NUMBER_VALUE'
};
gamelift.createGameSessionQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

    • TimeoutInSeconds — (Integer)

      The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

    • PlayerLatencyPolicies — (Array<map>)

      A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

      • MaximumIndividualPlayerLatencyMilliseconds — (Integer)

        The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

      • PolicyDurationSeconds — (Integer)

        The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

    • Destinations — (Array<map>)

      A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

      • DestinationArn — (String)

        The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

    • FilterConfiguration — (map)

      A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

      • AllowedLocations — (Array<String>)

        A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.

    • PriorityConfiguration — (map)

      Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

      • PriorityOrder — (Array<String>)

        The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

        • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

        • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.

        • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

        • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

      • LocationOrder — (Array<String>)

        The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by AWS Region codes such as us-west-2. Each location can only be listed once.

    • CustomEventData — (String)

      Information to be added to all events that are related to this game session queue.

    • NotificationTarget — (String)

      An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

    • Tags — (Array<map>)

      A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessionQueue — (map)

        An object that describes the newly created game session queue.

        • Name — (String)

          A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        • GameSessionQueueArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a GameLift game session queue ARN, the resource ID matches the Name value.

        • TimeoutInSeconds — (Integer)

          The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

        • PlayerLatencyPolicies — (Array<map>)

          A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

          • MaximumIndividualPlayerLatencyMilliseconds — (Integer)

            The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

          • PolicyDurationSeconds — (Integer)

            The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

        • Destinations — (Array<map>)

          A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

          • DestinationArn — (String)

            The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

        • FilterConfiguration — (map)

          A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

          • AllowedLocations — (Array<String>)

            A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.

        • PriorityConfiguration — (map)

          Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

          • PriorityOrder — (Array<String>)

            The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

            • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

            • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.

            • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

            • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

          • LocationOrder — (Array<String>)

            The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by AWS Region codes such as us-west-2. Each location can only be listed once.

        • CustomEventData — (String)

          Information that is added to all events that are related to this game session queue.

        • NotificationTarget — (String)

          An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createMatchmakingConfiguration(params = {}, callback) ⇒ AWS.Request

Defines a new matchmaking configuration for use with FlexMatch. Whether your are using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using GameLift hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests (StartMatchmaking or StartMatchBackfill) identify the matchmaking configuration to use and provide player attributes consistent with that configuration.

To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift hosting, you also need to identify the game session queue to use when starting a game session for the match.

In addition, you must set up an Amazon Simple Notification Service (SNS) topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration. An alternative method, continuously polling ticket status with DescribeMatchmaking, is only suitable for games in development with low matchmaking usage.

Learn more

Design a FlexMatch matchmaker

Set up FlexMatch event notification

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Service Reference:

Examples:

Calling the createMatchmakingConfiguration operation

var params = {
  AcceptanceRequired: true || false, /* required */
  Name: 'STRING_VALUE', /* required */
  RequestTimeoutSeconds: 'NUMBER_VALUE', /* required */
  RuleSetName: 'STRING_VALUE', /* required */
  AcceptanceTimeoutSeconds: 'NUMBER_VALUE',
  AdditionalPlayerCount: 'NUMBER_VALUE',
  BackfillMode: AUTOMATIC | MANUAL,
  CustomEventData: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  FlexMatchMode: STANDALONE | WITH_QUEUE,
  GameProperties: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  GameSessionData: 'STRING_VALUE',
  GameSessionQueueArns: [
    'STRING_VALUE',
    /* more items */
  ],
  NotificationTarget: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
gamelift.createMatchmakingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

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

    • Description — (String)

      A human-readable description of the matchmaking configuration.

    • GameSessionQueueArns — (Array<String>)

      The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

    • RequestTimeoutSeconds — (Integer)

      The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

    • AcceptanceTimeoutSeconds — (Integer)

      The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

    • AcceptanceRequired — (Boolean)

      A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

    • RuleSetName — (String)

      A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

    • NotificationTarget — (String)

      An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

    • AdditionalPlayerCount — (Integer)

      The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

    • CustomEventData — (String)

      Information to be added to all events related to this matchmaking configuration.

    • GameProperties — (Array<map>)

      A 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

      • Keyrequired — (String)

        The game property identifier.

      • Valuerequired — (String)

        The game property value.

    • GameSessionData — (String)

      A 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

    • BackfillMode — (String)

      The method used to backfill game sessions that are created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

      Possible values include:
      • "AUTOMATIC"
      • "MANUAL"
    • FlexMatchMode — (String)

      Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

      • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

      • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.

      Possible values include:
      • "STANDALONE"
      • "WITH_QUEUE"
    • Tags — (Array<map>)

      A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Configuration — (map)

        Object that describes the newly created matchmaking configuration.

        • Name — (String)

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

        • ConfigurationArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name>. In a GameLift configuration ARN, the resource ID matches the Name value.

        • Description — (String)

          A descriptive label that is associated with matchmaking configuration.

        • GameSessionQueueArns — (Array<String>)

          The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when FlexMatchMode is set to STANDALONE.

        • RequestTimeoutSeconds — (Integer)

          The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

        • AcceptanceTimeoutSeconds — (Integer)

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

        • AcceptanceRequired — (Boolean)

          A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

        • RuleSetName — (String)

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

        • RuleSetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

        • NotificationTarget — (String)

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

        • AdditionalPlayerCount — (Integer)

          The 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. This parameter is not used when FlexMatchMode is set to STANDALONE.

        • CustomEventData — (String)

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

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • GameProperties — (Array<map>)

          A 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. This parameter is not used when FlexMatchMode is set to STANDALONE.

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • GameSessionData — (String)

          A 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. This parameter is not used when FlexMatchMode is set to STANDALONE.

        • BackfillMode — (String)

          The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

          Possible values include:
          • "AUTOMATIC"
          • "MANUAL"
        • FlexMatchMode — (String)

          Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

          • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

          • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.

          Possible values include:
          • "STANDALONE"
          • "WITH_QUEUE"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createMatchmakingRuleSet(params = {}, callback) ⇒ AWS.Request

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. A rule set is used by a MatchmakingConfiguration.

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

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Service Reference:

Examples:

Calling the createMatchmakingRuleSet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RuleSetBody: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
gamelift.createMatchmakingRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

    • RuleSetBody — (String)

      A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

    • Tags — (Array<map>)

      A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RuleSet — (map)

        The newly created matchmaking rule set.

        • RuleSetName — (String)

          A unique identifier for the matchmaking rule set

        • RuleSetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.

        • RuleSetBodyrequired — (String)

          A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPlayerSession(params = {}, callback) ⇒ AWS.Request

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 PlayerSession object is returned with a player session ID. The player references the player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.

Available in Amazon GameLift Local.

Related actions

CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the createPlayerSession operation

var params = {
  GameSessionId: 'STRING_VALUE', /* required */
  PlayerId: 'STRING_VALUE', /* required */
  PlayerData: 'STRING_VALUE'
};
gamelift.createPlayerSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameSessionId — (String)

      A unique identifier for the game session to add a player to.

    • PlayerId — (String)

      A unique identifier for a player. Player IDs are developer-defined.

    • PlayerData — (String)

      Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlayerSession — (map)

        Object that describes the newly created player session record.

        • PlayerSessionId — (String)

          A unique identifier for a player session.

        • PlayerId — (String)

          A unique identifier for a player that is associated with this player session.

        • GameSessionId — (String)

          A unique identifier for the game session that the player session is connected to.

        • FleetId — (String)

          A unique identifier for the fleet that the player's game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Status — (String)

          Current status of the player session.

          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).

          Possible values include:
          • "RESERVED"
          • "ACTIVE"
          • "COMPLETED"
          • "TIMEDOUT"
        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

        • PlayerData — (String)

          Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createPlayerSessions(params = {}, callback) ⇒ AWS.Request

Reserves open slots in a game session for a group of players. New player sessions can be created in any game session with an open slot that is in ACTIVE status and has a player creation policy of ACCEPT_ALL. To add a single player to a game session, use CreatePlayerSession.

To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.

If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.

Available in Amazon GameLift Local.

Related actions

CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the createPlayerSessions operation

var params = {
  GameSessionId: 'STRING_VALUE', /* required */
  PlayerIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  PlayerDataMap: {
    '<NonZeroAndMaxString>': 'STRING_VALUE',
    /* '<NonZeroAndMaxString>': ... */
  }
};
gamelift.createPlayerSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameSessionId — (String)

      A unique identifier for the game session to add players to.

    • PlayerIds — (Array<String>)

      List of unique identifiers for the players to be added.

    • PlayerDataMap — (map<String>)

      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. Any player data strings for player IDs that are not included in the PlayerIds parameter are ignored.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlayerSessions — (Array<map>)

        A collection of player session objects created for the added players.

        • PlayerSessionId — (String)

          A unique identifier for a player session.

        • PlayerId — (String)

          A unique identifier for a player that is associated with this player session.

        • GameSessionId — (String)

          A unique identifier for the game session that the player session is connected to.

        • FleetId — (String)

          A unique identifier for the fleet that the player's game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Status — (String)

          Current status of the player session.

          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).

          Possible values include:
          • "RESERVED"
          • "ACTIVE"
          • "COMPLETED"
          • "TIMEDOUT"
        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

        • PlayerData — (String)

          Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createScript(params = {}, callback) ⇒ AWS.Request

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

  • A locally available directory. Use the ZipFile parameter for this option.

  • An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers

Set Up a Role for Amazon GameLift Access

Related actions

CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task

Service Reference:

Examples:

Calling the createScript operation

var params = {
  Name: 'STRING_VALUE',
  StorageLocation: {
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE',
    ObjectVersion: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Version: 'STRING_VALUE',
  ZipFile: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
};
gamelift.createScript(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

    • Version — (String)

      Version information that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

    • StorageLocation — (map)

      The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

      • Bucket — (String)

        An Amazon S3 bucket identifier. This is the name of the S3 bucket.

        Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
      • Key — (String)

        The name of the zip file that contains the build files or script files.

      • RoleArn — (String)

        The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

      • ObjectVersion — (String)

        The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

    • ZipFile — (Buffer, Typed Array, Blob, String)

      A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

      When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

    • Tags — (Array<map>)

      A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Script — (map)

        The newly created script record with a unique script ID and ARN. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.

        • ScriptId — (String)

          A unique identifier for the Realtime script

        • ScriptArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

        • Name — (String)

          A descriptive label that is associated with a script. Script names do not need to be unique.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique.

        • SizeOnDisk — (Integer)

          The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • StorageLocation — (map)

          The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.

          • Bucket — (String)

            An Amazon S3 bucket identifier. This is the name of the S3 bucket.

            Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
          • Key — (String)

            The name of the zip file that contains the build files or script files.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

          • ObjectVersion — (String)

            The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createVpcPeeringAuthorization(params = {}, callback) ⇒ AWS.Request

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.

Related actions

CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task

Service Reference:

Examples:

Calling the createVpcPeeringAuthorization operation

var params = {
  GameLiftAwsAccountId: 'STRING_VALUE', /* required */
  PeerVpcId: 'STRING_VALUE' /* required */
};
gamelift.createVpcPeeringAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameLiftAwsAccountId — (String)

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

    • PeerVpcId — (String)

      A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcPeeringAuthorization — (map)

        Details on the requested VPC peering authorization, including expiration.

        • GameLiftAwsAccountId — (String)

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

        • PeerVpcAwsAccountId — (String)

        • PeerVpcId — (String)

          A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

        • CreationTime — (Date)

          Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • ExpirationTime — (Date)

          Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request

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.

Related actions

CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task

Service Reference:

Examples:

Calling the createVpcPeeringConnection operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  PeerVpcAwsAccountId: 'STRING_VALUE', /* required */
  PeerVpcId: 'STRING_VALUE' /* required */
};
gamelift.createVpcPeeringConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which GameLift VPC to peer with.

    • PeerVpcAwsAccountId — (String)

      A 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.

    • PeerVpcId — (String)

      A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAlias(params = {}, callback) ⇒ AWS.Request

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

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Service Reference:

Examples:

Calling the deleteAlias operation

var params = {
  AliasId: 'STRING_VALUE' /* required */
};
gamelift.deleteAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasId — (String)

      A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBuild(params = {}, callback) ⇒ AWS.Request

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

Upload a Custom Server Build

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

Service Reference:

Examples:

Calling the deleteBuild operation

var params = {
  BuildId: 'STRING_VALUE' /* required */
};
gamelift.deleteBuild(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BuildId — (String)

      A unique identifier for the build to delete. You can use either the build ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFleet(params = {}, callback) ⇒ AWS.Request

Deletes all resources and information related a fleet. Any current fleet instances, including those in remote locations, are shut down. You don't need to call DeleteFleetLocations separately.

Note: If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process.

To delete a fleet, specify the fleet ID to be terminated. During the deletion process the fleet status is changed to DELETING. When completed, the status switches to TERMINATED and the fleet event FLEET_DELETED is sent.

Learn more

Setting up GameLift Fleets

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Service Reference:

Examples:

Calling the deleteFleet operation

var params = {
  FleetId: 'STRING_VALUE' /* required */
};
gamelift.deleteFleet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFleetLocations(params = {}, callback) ⇒ AWS.Request

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

Setting up GameLift fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Service Reference:

Examples:

Calling the deleteFleetLocations operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Locations: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
gamelift.deleteFleetLocations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to delete locations for. You can use either the fleet ID or ARN value.

    • Locations — (Array<String>)

      The list of fleet locations to delete. Specify locations in the form of an AWS Region code, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that location attributes are being deleted for.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      • LocationStates — (Array<map>)

        The remote locations that are being deleted, with each location status set to DELETING.

        • Location — (String)

          The fleet location, expressed as an AWS Region code such as us-west-2.

        • Status — (String)

          The life-cycle status of a fleet location.

          Possible values include:
          • "NEW"
          • "DOWNLOADING"
          • "VALIDATING"
          • "BUILDING"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETING"
          • "ERROR"
          • "TERMINATED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteGameServerGroup(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

  • The game server group

  • The corresponding Auto Scaling group

  • All game servers that are currently running in the group

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the deleteGameServerGroup operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  DeleteOption: SAFE_DELETE | FORCE_DELETE | RETAIN
};
gamelift.deleteGameServerGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

    • DeleteOption — (String)

      The type of delete to perform. Options include the following:

      • SAFE_DELETE – (default) Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

      • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.

      • RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.

      Possible values include:
      • "SAFE_DELETE"
      • "FORCE_DELETE"
      • "RETAIN"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroup — (map)

        An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteGameSessionQueue(params = {}, callback) ⇒ AWS.Request

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.

Learn more

Using Multi-Region Queues

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Service Reference:

Examples:

Calling the deleteGameSessionQueue operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
gamelift.deleteGameSessionQueue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMatchmakingConfiguration(params = {}, callback) ⇒ AWS.Request

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.

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Service Reference:

Examples:

Calling the deleteMatchmakingConfiguration operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
gamelift.deleteMatchmakingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A unique identifier for the matchmaking configuration. You can use either the configuration name or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMatchmakingRuleSet(params = {}, callback) ⇒ AWS.Request

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

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Service Reference:

Examples:

Calling the deleteMatchmakingRuleSet operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
gamelift.deleteMatchmakingRuleSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A unique identifier for the matchmaking rule set to be deleted. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteScalingPolicy(params = {}, callback) ⇒ AWS.Request

Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and GameLift removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

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

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

Service Reference:

Examples:

Calling the deleteScalingPolicy operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
gamelift.deleteScalingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

    • FleetId — (String)

      A unique identifier for the fleet to be deleted. You can use either the fleet ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteScript(params = {}, callback) ⇒ AWS.Request

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

CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task

Service Reference:

Examples:

Calling the deleteScript operation

var params = {
  ScriptId: 'STRING_VALUE' /* required */
};
gamelift.deleteScript(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScriptId — (String)

      A unique identifier for the Realtime script to delete. You can use either the script ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVpcPeeringAuthorization(params = {}, callback) ⇒ AWS.Request

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, call DeleteVpcPeeringConnection.

Related actions

CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task

Service Reference:

Examples:

Calling the deleteVpcPeeringAuthorization operation

var params = {
  GameLiftAwsAccountId: 'STRING_VALUE', /* required */
  PeerVpcId: 'STRING_VALUE' /* required */
};
gamelift.deleteVpcPeeringAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameLiftAwsAccountId — (String)

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

    • PeerVpcId — (String)

      A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVpcPeeringConnection(params = {}, callback) ⇒ AWS.Request

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. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.

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.

Related actions

CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task

Service Reference:

Examples:

Calling the deleteVpcPeeringConnection operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  VpcPeeringConnectionId: 'STRING_VALUE' /* required */
};
gamelift.deleteVpcPeeringConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet. This fleet specified must match the fleet referenced in the VPC peering connection record. You can use either the fleet ID or ARN value.

    • VpcPeeringConnectionId — (String)

      A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deregisterGameServer(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Service Reference:

Examples:

Calling the deregisterGameServer operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  GameServerId: 'STRING_VALUE' /* required */
};
gamelift.deregisterGameServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

    • GameServerId — (String)

      A custom string that uniquely identifies the game server to deregister.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAlias(params = {}, callback) ⇒ AWS.Request

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

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Service Reference:

Examples:

Calling the describeAlias operation

var params = {
  AliasId: 'STRING_VALUE' /* required */
};
gamelift.describeAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasId — (String)

      The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Alias — (map)

        The requested alias resource.

        • AliasId — (String)

          A unique identifier for the alias. Alias IDs are unique within a Region.

        • Name — (String)

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

        • AliasArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

        • Description — (String)

          A human-readable description of an alias.

        • RoutingStrategy — (map)

          The routing configuration, including routing type and fleet target, for the alias.

          • Type — (String)

            The type of routing strategy for the alias.

            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.

            Possible values include:
            • "SIMPLE"
            • "TERMINAL"
          • FleetId — (String)

            A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

          • Message — (String)

            The message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeBuild(params = {}, callback) ⇒ AWS.Request

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

Upload a Custom Server Build

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

Service Reference:

Examples:

Calling the describeBuild operation

var params = {
  BuildId: 'STRING_VALUE' /* required */
};
gamelift.describeBuild(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BuildId — (String)

      A unique identifier for the build to retrieve properties for. You can use either the build ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Build — (map)

        Set of properties describing the requested build.

        • BuildId — (String)

          A unique identifier for the build.

        • BuildArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

        • Name — (String)

          A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

        • Status — (String)

          Current status of the build.

          Possible build statuses include the following:

          • 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.

          Possible values include:
          • "INITIALIZED"
          • "READY"
          • "FAILED"
        • SizeOnDisk — (Integer)

          File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

        • OperatingSystem — (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.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeEC2InstanceLimits(params = {}, callback) ⇒ AWS.Request

The GameLift service limits and current utilization for an AWS Region or location. Instance limits control the number of instances, per instance type, per location, that your AWS account can use. Learn more at Amazon EC2 Instance Types. The information returned includes the maximum number of instances allowed and your account's current usage across all fleets. This information can affect your ability to scale your GameLift fleets. You can request a limit increase for your account by using the Service limits page in the GameLift console.

Instance limits differ based on whether the instances are deployed in a fleet's home Region or in a remote location. For remote locations, limits also differ based on the combination of home Region and remote location. All requests must specify an AWS Region (either explicitly or as your default settings). To get the limit for a remote location, you must also specify the location. For example, the following requests all return different results:

  • Request specifies the Region ap-northeast-1 with no location. The result is limits and usage data on all instance types that are deployed in us-east-2, by all of the fleets that reside in ap-northeast-1.

  • Request specifies the Region us-east-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in us-east-2. These limits do not affect fleets in any other Regions that deploy instances to ca-central-1.

  • Request specifies the Region eu-west-1 with location ca-central-1. The result is limits and usage data on all instance types that are deployed in ca-central-1, by all of the fleets that reside in eu-west-1.

This operation can be used in the following ways:

  • To get limit and usage data for all instance types that are deployed in an AWS 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 AWS Region: Provide both the AWS Region and the remote location. Optionally, specify a single instance type to retrieve information for.

If successful, an EC2InstanceLimits object is returned with limits and usage data for each requested instance type.

Learn more

Setting up GameLift fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Service Reference:

Examples:

Calling the describeEC2InstanceLimits operation

var params = {
  EC2InstanceType: t2.micro | t2.small | t2.medium | t2.large | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge,
  Location: 'STRING_VALUE'
};
gamelift.describeEC2InstanceLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EC2InstanceType — (String)

      Name of an EC2 instance type that is supported in GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Do not specify a value for this parameter to retrieve limits for all instance types.

      Possible values include:
      • "t2.micro"
      • "t2.small"
      • "t2.medium"
      • "t2.large"
      • "c3.large"
      • "c3.xlarge"
      • "c3.2xlarge"
      • "c3.4xlarge"
      • "c3.8xlarge"
      • "c4.large"
      • "c4.xlarge"
      • "c4.2xlarge"
      • "c4.4xlarge"
      • "c4.8xlarge"
      • "c5.large"
      • "c5.xlarge"
      • "c5.2xlarge"
      • "c5.4xlarge"
      • "c5.9xlarge"
      • "c5.12xlarge"
      • "c5.18xlarge"
      • "c5.24xlarge"
      • "c5a.large"
      • "c5a.xlarge"
      • "c5a.2xlarge"
      • "c5a.4xlarge"
      • "c5a.8xlarge"
      • "c5a.12xlarge"
      • "c5a.16xlarge"
      • "c5a.24xlarge"
      • "r3.large"
      • "r3.xlarge"
      • "r3.2xlarge"
      • "r3.4xlarge"
      • "r3.8xlarge"
      • "r4.large"
      • "r4.xlarge"
      • "r4.2xlarge"
      • "r4.4xlarge"
      • "r4.8xlarge"
      • "r4.16xlarge"
      • "r5.large"
      • "r5.xlarge"
      • "r5.2xlarge"
      • "r5.4xlarge"
      • "r5.8xlarge"
      • "r5.12xlarge"
      • "r5.16xlarge"
      • "r5.24xlarge"
      • "r5a.large"
      • "r5a.xlarge"
      • "r5a.2xlarge"
      • "r5a.4xlarge"
      • "r5a.8xlarge"
      • "r5a.12xlarge"
      • "r5a.16xlarge"
      • "r5a.24xlarge"
      • "m3.medium"
      • "m3.large"
      • "m3.xlarge"
      • "m3.2xlarge"
      • "m4.large"
      • "m4.xlarge"
      • "m4.2xlarge"
      • "m4.4xlarge"
      • "m4.10xlarge"
      • "m5.large"
      • "m5.xlarge"
      • "m5.2xlarge"
      • "m5.4xlarge"
      • "m5.8xlarge"
      • "m5.12xlarge"
      • "m5.16xlarge"
      • "m5.24xlarge"
      • "m5a.large"
      • "m5a.xlarge"
      • "m5a.2xlarge"
      • "m5a.4xlarge"
      • "m5a.8xlarge"
      • "m5a.12xlarge"
      • "m5a.16xlarge"
      • "m5a.24xlarge"
    • Location — (String)

      The name of a remote location to request instance limits for, in the form of an AWS Region code such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EC2InstanceLimits — (Array<map>)

        The maximum number of instances for the specified instance type.

        • EC2InstanceType — (String)

          The name of an EC2 instance type. See Amazon EC2 Instance Types for detailed descriptions.

          Possible values include:
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
        • CurrentInstances — (Integer)

          The number of instances for the specified type and location that are currently being used by the AWS account.

        • InstanceLimit — (Integer)

          The number of instances that is allowed for the specified instance type and location.

        • Location — (String)

          An AWS Region code, such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetAttributes(params = {}, callback) ⇒ AWS.Request

Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.

This operation can be used in the following ways:

  • To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get attributes for all fleets, do not provide a fleet identifier.

When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.

Note: Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.

Learn more

Setting up GameLift fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Service Reference:

Examples:

Calling the describeFleetAttributes operation

var params = {
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.describeFleetAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetIds — (Array<String>)

      A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.

    • Limit — (Integer)

      The 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.

    • NextToken — (String)

      A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetAttributes — (Array<map>)

        A collection of objects containing attribute metadata for each requested fleet ID. Attribute objects are returned only for fleets that currently exist.

        • FleetId — (String)

          A unique identifier for the fleet.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.

        • FleetType — (String)

          The kind of instances, On-Demand or Spot, that this fleet uses.

          Possible values include:
          • "ON_DEMAND"
          • "SPOT"
        • InstanceType — (String)

          The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

          Possible values include:
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
        • Description — (String)

          A human-readable description of the fleet.

        • Name — (String)

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

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Status — (String)

          Current status of the fleet. Possible fleet statuses include the following:

          • NEW -- A new fleet has been defined and desired instances is set to 1.

          • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

          • ACTIVE -- Hosts can now accept game sessions.

          • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

          • DELETING -- Hosts are responding to a delete fleet request.

          • TERMINATED -- The fleet no longer exists.

          Possible values include:
          • "NEW"
          • "DOWNLOADING"
          • "VALIDATING"
          • "BUILDING"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETING"
          • "ERROR"
          • "TERMINATED"
        • BuildId — (String)

          A unique identifier for the build resource that is deployed on instances in this fleet.

        • BuildArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

        • ScriptId — (String)

          A unique identifier for the Realtime script resource that is deployed on instances in this fleet.

        • ScriptArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

        • ServerLaunchPath — (String)

          This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

        • ServerLaunchParameters — (String)

          This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.

        • LogPaths — (Array<String>)

          This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.

        • NewGameSessionProtectionPolicy — (String)

          The type of game session protection to set on all new instances that are started in the fleet.

          • 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.

          Possible values include:
          • "NoProtection"
          • "FullProtection"
        • OperatingSystem — (String)

          The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • ResourceCreationLimitPolicy — (map)

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

          • NewGameSessionsPerCreator — (Integer)

            The maximum number of game sessions that an individual can create during the policy period.

          • PolicyPeriodInMinutes — (Integer)

            The time span used in evaluating the resource creation limit policy.

        • MetricGroups — (Array<String>)

          Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.

        • StoppedActions — (Array<String>)

          A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.

        • InstanceRoleArn — (String)

          A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

        • CertificateConfiguration — (map)

          Indicates whether a TLS/SSL certificate was generated for the fleet.

          • CertificateTyperequired — (String)

            Indicates whether a TLS/SSL certificate is generated for a fleet.

            Valid values include:

            • GENERATED - Generate a TLS/SSL certificate for this fleet.

            • DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.

            Possible values include:
            • "DISABLED"
            • "GENERATED"
      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetCapacity(params = {}, callback) ⇒ AWS.Request

Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationCapacity to get capacity settings for a fleet's remote locations.

This operation can be used in the following ways:

  • To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.

  • To get capacity data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects are returned only for fleets that currently exist.

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

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Service Reference:

Examples:

Calling the describeFleetCapacity operation

var params = {
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.describeFleetCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetIds — (Array<String>)

      A unique identifier for the fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

    • Limit — (Integer)

      The 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.

    • NextToken — (String)

      A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetCapacity — (Array<map>)

        A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist.

        • FleetId — (String)

          A unique identifier for the fleet associated with the location.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • InstanceType — (String)

          The EC2 instance type that is used for all instances in a fleet. The instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

          Possible values include:
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
        • InstanceCounts — (map)

          The current instance count and capacity settings for the fleet location.

          • DESIRED — (Integer)

            Ideal number of active instances. GameLift will always try to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances.

          • MINIMUM — (Integer)

            The minimum instance count value allowed.

          • MAXIMUM — (Integer)

            The maximum instance count value allowed.

          • PENDING — (Integer)

            Number of instances that are starting but not yet active.

          • ACTIVE — (Integer)

            Actual number of instances that are ready to host game sessions.

          • IDLE — (Integer)

            Number of active instances that are not currently hosting a game session.

          • TERMINATING — (Integer)

            Number of instances that are no longer active but haven't yet been terminated.

        • Location — (String)

          The fleet location for the instance count information, expressed as an AWS Region code, such as us-west-2.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetEvents(params = {}, callback) ⇒ AWS.Request

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 GameLift fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Service Reference:

Examples:

Calling the describeFleetEvents operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
gamelift.describeFleetEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to get event logs for. You can use either the fleet ID or ARN value.

    • StartTime — (Date)

      The 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").

    • EndTime — (Date)

      The 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)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Events — (Array<map>)

        A collection of objects containing event log entries for the specified fleet.

        • EventId — (String)

          A unique identifier for a fleet event.

        • ResourceId — (String)

          A unique identifier for an event resource, such as a fleet ID.

        • EventCode — (String)

          The type of event being logged.

          Fleet creation events (ordered by fleet creation activity):

          • FLEET_CREATED -- A fleet resource was successfully created with a status of NEW. Event messaging includes the fleet ID.

          • FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.

          • FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.

          • FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.

          • FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.

          • FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the GameLift is now verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If any listed launch path exists, GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.

          • FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING.

          • FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable specified in a launch path does not exist on the instance.

          • FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING.

          • FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the executable specified in a launch path failed to run on the fleet instance.

          • FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING.

          • FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. Learn more at Debug Fleet Creation Issues

          • FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.

          VPC peering events:

          • FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an GameLift fleet and a VPC in your AWS account.

          • FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html

          • FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.

          Spot instance events:

          • INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.

          Other fleet events:

          • FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.

          • FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.

          • FLEET_DELETED -- A request to delete a fleet was initiated.

          • GENERIC_EVENT -- An unspecified event has occurred.

          Possible values include:
          • "GENERIC_EVENT"
          • "FLEET_CREATED"
          • "FLEET_DELETED"
          • "FLEET_SCALING_EVENT"
          • "FLEET_STATE_DOWNLOADING"
          • "FLEET_STATE_VALIDATING"
          • "FLEET_STATE_BUILDING"
          • "FLEET_STATE_ACTIVATING"
          • "FLEET_STATE_ACTIVE"
          • "FLEET_STATE_ERROR"
          • "FLEET_INITIALIZATION_FAILED"
          • "FLEET_BINARY_DOWNLOAD_FAILED"
          • "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND"
          • "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE"
          • "FLEET_VALIDATION_TIMED_OUT"
          • "FLEET_ACTIVATION_FAILED"
          • "FLEET_ACTIVATION_FAILED_NO_INSTANCES"
          • "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED"
          • "SERVER_PROCESS_INVALID_PATH"
          • "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT"
          • "SERVER_PROCESS_PROCESS_READY_TIMEOUT"
          • "SERVER_PROCESS_CRASHED"
          • "SERVER_PROCESS_TERMINATED_UNHEALTHY"
          • "SERVER_PROCESS_FORCE_TERMINATED"
          • "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT"
          • "GAME_SESSION_ACTIVATION_TIMEOUT"
          • "FLEET_CREATION_EXTRACTING_BUILD"
          • "FLEET_CREATION_RUNNING_INSTALLER"
          • "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG"
          • "FLEET_VPC_PEERING_SUCCEEDED"
          • "FLEET_VPC_PEERING_FAILED"
          • "FLEET_VPC_PEERING_DELETED"
          • "INSTANCE_INTERRUPTED"
        • Message — (String)

          Additional information related to the event.

        • EventTime — (Date)

          Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • PreSignedLogUrl — (String)

          Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the GameLift console.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetLocationAttributes(params = {}, callback) ⇒ AWS.Request

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 GameLift fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Service Reference:

Examples:

Calling the describeFleetLocationAttributes operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Locations: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
gamelift.describeFleetLocationAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.

    • Locations — (Array<String>)

      A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as us-west-2.

    • Limit — (Integer)

      The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that location attributes were requested for.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      • LocationAttributes — (Array<map>)

        Location-specific information on the requested fleet's remote locations.

        • LocationState — (map)

          A fleet location and its current life-cycle state.

          • Location — (String)

            The fleet location, expressed as an AWS Region code such as us-west-2.

          • Status — (String)

            The life-cycle status of a fleet location.

            Possible values include:
            • "NEW"
            • "DOWNLOADING"
            • "VALIDATING"
            • "BUILDING"
            • "ACTIVATING"
            • "ACTIVE"
            • "DELETING"
            • "ERROR"
            • "TERMINATED"
        • StoppedActions — (Array<String>)

          A list of fleet actions that have been suspended in the fleet location.

        • UpdateStatus — (String)

          The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.

          Possible values include:
          • "PENDING_UPDATE"
      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetLocationCapacity(params = {}, callback) ⇒ AWS.Request

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity object is returned for the requested fleet location.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Service Reference:

Examples:

Calling the describeFleetLocationCapacity operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Location: 'STRING_VALUE' /* required */
};
gamelift.describeFleetLocationCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.

    • Location — (String)

      The fleet location to retrieve capacity information for. Specify a location in the form of an AWS Region code, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetCapacity — (map)

        Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.

        • FleetId — (String)

          A unique identifier for the fleet associated with the location.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • InstanceType — (String)

          The EC2 instance type that is used for all instances in a fleet. The instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

          Possible values include:
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
        • InstanceCounts — (map)

          The current instance count and capacity settings for the fleet location.

          • DESIRED — (Integer)

            Ideal number of active instances. GameLift will always try to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances.

          • MINIMUM — (Integer)

            The minimum instance count value allowed.

          • MAXIMUM — (Integer)

            The maximum instance count value allowed.

          • PENDING — (Integer)

            Number of instances that are starting but not yet active.

          • ACTIVE — (Integer)

            Actual number of instances that are ready to host game sessions.

          • IDLE — (Integer)

            Number of active instances that are not currently hosting a game session.

          • TERMINATING — (Integer)

            Number of instances that are no longer active but haven't yet been terminated.

        • Location — (String)

          The fleet location for the instance count information, expressed as an AWS Region code, such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetLocationUtilization(params = {}, callback) ⇒ AWS.Request

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 GameLift fleets

GameLift metrics for fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Examples:

Calling the describeFleetLocationUtilization operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Location: 'STRING_VALUE' /* required */
};
gamelift.describeFleetLocationUtilization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.

    • Location — (String)

      The fleet location to retrieve utilization information for. Specify a location in the form of an AWS Region code, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetUtilization — (map)

        Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.

        • FleetId — (String)

          A unique identifier for the fleet associated with the location.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • ActiveServerProcessCount — (Integer)

          The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.

        • ActiveGameSessionCount — (Integer)

          The number of active game sessions that are currently being hosted across all instances in the fleet location.

        • CurrentPlayerSessionCount — (Integer)

          The number of active player sessions that are currently being hosted across all instances in the fleet location.

        • MaximumPlayerSessionCount — (Integer)

          The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.

        • Location — (String)

          The fleet location for the fleet utilization information, expressed as an AWS Region code, such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetPortSettings(params = {}, callback) ⇒ AWS.Request

Retrieves a fleet's inbound connection permissions. Connection permissions specify the range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. Game sessions that are running on instances in the fleet must use connections that fall in this range.

This operation can be used in the following ways:

  • To retrieve the inbound connection permissions for a fleet, identify the fleet's unique identifier.

  • To check the status of recent updates to a fleet remote location, specify the fleet ID and a location. Port setting updates can take time to propagate across all locations.

If successful, a set of IpPermission objects is returned for the requested fleet ID. When a location is specified, a pending status is included. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Service Reference:

Examples:

Calling the describeFleetPortSettings operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Location: 'STRING_VALUE'
};
gamelift.describeFleetPortSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to retrieve port settings for. You can use either the fleet ID or ARN value.

    • Location — (String)

      A remote location to check for status of port setting updates. Use the AWS Region code format, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that was requested.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      • InboundPermissions — (Array<map>)

        The port settings for the requested fleet ID.

        • FromPortrequired — (Integer)

          A starting value for a range of allowed port numbers.

        • ToPortrequired — (Integer)

          An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

        • IpRangerequired — (String)

          A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".

        • Protocolrequired — (String)

          The network communication protocol used by the fleet.

          Possible values include:
          • "TCP"
          • "UDP"
      • UpdateStatus — (String)

        The current status of updates to the fleet's port settings in the requested fleet location. A status of PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

        Possible values include:
        • "PENDING_UPDATE"
      • Location — (String)

        The requested fleet location, expressed as an AWS Region code, such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFleetUtilization(params = {}, callback) ⇒ AWS.Request

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.

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

Learn more

Setting up GameLift Fleets

GameLift Metrics for Fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Service Reference:

Examples:

Calling the describeFleetUtilization operation

var params = {
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.describeFleetUtilization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetIds — (Array<String>)

      A unique identifier for the fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.

    • Limit — (Integer)

      The 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.

    • NextToken — (String)

      A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetUtilization — (Array<map>)

        A collection of objects containing utilization information for each requested fleet ID. Utilization objects are returned only for fleets that currently exist.

        • FleetId — (String)

          A unique identifier for the fleet associated with the location.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • ActiveServerProcessCount — (Integer)

          The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.

        • ActiveGameSessionCount — (Integer)

          The number of active game sessions that are currently being hosted across all instances in the fleet location.

        • CurrentPlayerSessionCount — (Integer)

          The number of active player sessions that are currently being hosted across all instances in the fleet location.

        • MaximumPlayerSessionCount — (Integer)

          The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.

        • Location — (String)

          The fleet location for the fleet utilization information, expressed as an AWS Region code, such as us-west-2.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameServer(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Service Reference:

Examples:

Calling the describeGameServer operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  GameServerId: 'STRING_VALUE' /* required */
};
gamelift.describeGameServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

    • GameServerId — (String)

      A custom string that uniquely identifies the game server information to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServer — (map)

        Object that describes the requested game server.

        • GameServerGroupName — (String)

          A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

        • GameServerGroupArn — (String)

          The ARN identifier for the game server group where the game server is located.

        • GameServerId — (String)

          A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

        • InstanceId — (String)

          The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

        • ConnectionInfo — (String)

          The port and IP address that must be used to establish a client connection to the game server.

        • GameServerData — (String)

          A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

        • ClaimStatus — (String)

          Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

          Possible values include:
          • "CLAIMED"
        • UtilizationStatus — (String)

          Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

          • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

          • UTILIZED - The game server is currently hosting a game session with players.

          Possible values include:
          • "AVAILABLE"
          • "UTILIZED"
        • RegistrationTime — (Date)

          Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastClaimTime — (Date)

          Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

        • LastHealthCheckTime — (Date)

          Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameServerGroup(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the describeGameServerGroup operation

var params = {
  GameServerGroupName: 'STRING_VALUE' /* required */
};
gamelift.describeGameServerGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroup — (map)

        An object with the property settings for the requested game server group resource.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameServerInstances(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties.

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

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the describeGameServerInstances operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  InstanceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.describeGameServerInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

    • InstanceIds — (Array<String>)

      The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerInstances — (Array<map>)

        The collection of requested game server instances.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique identifier for the game server group that includes the game server instance.

        • InstanceId — (String)

          The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

        • InstanceStatus — (String)

          Current status of the game server instance.

          • ACTIVE -- The instance is viable for hosting game servers.

          • DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

          • SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

          Possible values include:
          • "ACTIVE"
          • "DRAINING"
          • "SPOT_TERMINATING"
      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameSessionDetails(params = {}, callback) ⇒ AWS.Request

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. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions.

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 AWS 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

Find a game session

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the describeGameSessionDetails operation

var params = {
  AliasId: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  GameSessionId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Location: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StatusFilter: 'STRING_VALUE'
};
gamelift.describeGameSessionDetails(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

    • GameSessionId — (String)

      A unique identifier for the game session to retrieve.

    • AliasId — (String)

      A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

    • Location — (String)

      A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

    • StatusFilter — (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)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessionDetails — (Array<map>)

        A collection of properties for each game session that matches the request.

        • GameSession — (map)

          Object that describes a game session.

          • GameSessionId — (String)

            A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

          • Name — (String)

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

          • FleetId — (String)

            A unique identifier for the fleet that the game session is running on.

          • FleetArn — (String)

            The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

          • CreationTime — (Date)

            A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

          • TerminationTime — (Date)

            A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

          • CurrentPlayerSessionCount — (Integer)

            Number of players currently in the game session.

          • MaximumPlayerSessionCount — (Integer)

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

          • Status — (String)

            Current status of the game session. A game session must have an ACTIVE status to have player sessions.

            Possible values include:
            • "ACTIVE"
            • "ACTIVATING"
            • "TERMINATED"
            • "TERMINATING"
            • "ERROR"
          • StatusReason — (String)

            Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

            Possible values include:
            • "INTERRUPTED"
          • GameProperties — (Array<map>)

            A 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. You can search for active game sessions based on this custom data with SearchGameSessions.

            • Keyrequired — (String)

              The game property identifier.

            • Valuerequired — (String)

              The game property value.

          • IpAddress — (String)

            The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • DnsName — (String)

            The DNS identifier assigned to the instance that is running the game session. Values have the following format:

            • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

            • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

            When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

          • Port — (Integer)

            The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • PlayerSessionCreationPolicy — (String)

            Indicates whether or not the game session is accepting new players.

            Possible values include:
            • "ACCEPT_ALL"
            • "DENY_ALL"
          • CreatorId — (String)

            A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

          • GameSessionData — (String)

            A 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.

          • MatchmakerData — (String)

            Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

          • Location — (String)

            The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

        • ProtectionPolicy — (String)

          Current status of protection for the game session.

          • 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.

          Possible values include:
          • "NoProtection"
          • "FullProtection"
      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameSessionPlacement(params = {}, callback) ⇒ AWS.Request

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

If successful, a GameSessionPlacement object is returned.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the describeGameSessionPlacement operation

var params = {
  PlacementId: 'STRING_VALUE' /* required */
};
gamelift.describeGameSessionPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PlacementId — (String)

      A unique identifier for a game session placement to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessionPlacement — (map)

        Object that describes the requested game session placement.

        • PlacementId — (String)

          A unique identifier for a game session placement.

        • GameSessionQueueName — (String)

          A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        • Status — (String)

          Current status of the game session placement request.

          • PENDING -- The placement request is currently in the queue waiting to be processed.

          • FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

          • CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

          • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

          • FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

          Possible values include:
          • "PENDING"
          • "FULFILLED"
          • "CANCELLED"
          • "TIMED_OUT"
          • "FAILED"
        • GameProperties — (Array<map>)

          A 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).

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • MaximumPlayerSessionCount — (Integer)

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

        • GameSessionName — (String)

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

        • GameSessionId — (String)

          A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

        • GameSessionArn — (String)

          Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.

        • GameSessionRegion — (String)

          Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

        • PlayerLatencies — (Array<map>)

          A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.

          • PlayerId — (String)

            A unique identifier for a player associated with the latency data.

          • RegionIdentifier — (String)

            Name of the Region that is associated with the latency value.

          • LatencyInMilliseconds — (Float)

            Amount of time that represents the time lag experienced by the player when connected to the specified Region.

        • StartTime — (Date)

          Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • EndTime — (Date)

          Time stamp indicating when this request was completed, canceled, or timed out.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

        • PlacedPlayerSessions — (Array<map>)

          A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

          • PlayerId — (String)

            A unique identifier for a player that is associated with this player session.

          • PlayerSessionId — (String)

            A unique identifier for a player session.

        • GameSessionData — (String)

          A 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).

        • MatchmakerData — (String)

          Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameSessionQueues(params = {}, callback) ⇒ AWS.Request

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.

Learn more

View Your Queues

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Service Reference:

Examples:

Calling the describeGameSessionQueues operation

var params = {
  Limit: 'NUMBER_VALUE',
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
gamelift.describeGameSessionQueues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)

      A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.

    • Limit — (Integer)

      The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessionQueues — (Array<map>)

        A collection of objects that describe the requested game session queues.

        • Name — (String)

          A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        • GameSessionQueueArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. In a GameLift game session queue ARN, the resource ID matches the Name value.

        • TimeoutInSeconds — (Integer)

          The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

        • PlayerLatencyPolicies — (Array<map>)

          A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

          • MaximumIndividualPlayerLatencyMilliseconds — (Integer)

            The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

          • PolicyDurationSeconds — (Integer)

            The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

        • Destinations — (Array<map>)

          A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

          • DestinationArn — (String)

            The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

        • FilterConfiguration — (map)

          A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.

          • AllowedLocations — (Array<String>)

            A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2.

        • PriorityConfiguration — (map)

          Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

          • PriorityOrder — (Array<String>)

            The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

            • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

            • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.

            • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

            • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

          • LocationOrder — (Array<String>)

            The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION. Locations are identified by AWS Region codes such as us-west-2. Each location can only be listed once.

        • CustomEventData — (String)

          Information that is added to all events that are related to this game session queue.

        • NotificationTarget — (String)

          An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGameSessions(params = {}, callback) ⇒ AWS.Request

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. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve the protection policy for game sessions, use DescribeGameSessionDetails.

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 AWS 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.

Available in GameLift Local.

Learn more

Find a game session

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the describeGameSessions operation

var params = {
  AliasId: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  GameSessionId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Location: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StatusFilter: 'STRING_VALUE'
};
gamelift.describeGameSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

    • GameSessionId — (String)

      A unique identifier for the game session to retrieve.

    • AliasId — (String)

      A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

    • Location — (String)

      A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

    • StatusFilter — (String)

      Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessions — (Array<map>)

        A collection of properties for each game session that matches the request.

        • GameSessionId — (String)

          A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

        • Name — (String)

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

        • FleetId — (String)

          A unique identifier for the fleet that the game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • CurrentPlayerSessionCount — (Integer)

          Number of players currently in the game session.

        • MaximumPlayerSessionCount — (Integer)

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

        • Status — (String)

          Current status of the game session. A game session must have an ACTIVE status to have player sessions.

          Possible values include:
          • "ACTIVE"
          • "ACTIVATING"
          • "TERMINATED"
          • "TERMINATING"
          • "ERROR"
        • StatusReason — (String)

          Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

          Possible values include:
          • "INTERRUPTED"
        • GameProperties — (Array<map>)

          A 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. You can search for active game sessions based on this custom data with SearchGameSessions.

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • PlayerSessionCreationPolicy — (String)

          Indicates whether or not the game session is accepting new players.

          Possible values include:
          • "ACCEPT_ALL"
          • "DENY_ALL"
        • CreatorId — (String)

          A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

        • GameSessionData — (String)

          A 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.

        • MatchmakerData — (String)

          Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

        • Location — (String)

          The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeInstances(params = {}, callback) ⇒ AWS.Request

Retrieves information about a fleet's instances, including instance IDs, connection data, and status.

This operation can be used in the following ways:

  • To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.

  • To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.

  • To get information on a specific instance in a fleet, provide the fleet ID and instance ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task

Service Reference:

Examples:

Calling the describeInstances operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Location: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.describeInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

    • InstanceId — (String)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

    • Location — (String)

      The name of a location to retrieve instance information for, in the form of an AWS Region code such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Instances — (Array<map>)

        A collection of objects containing properties for each instance returned.

        • FleetId — (String)

          A unique identifier for the fleet that the instance is in.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • InstanceId — (String)

          A unique identifier for the instance.

        • IpAddress — (String)

          IP address that is assigned to the instance.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • OperatingSystem — (String)

          Operating system that is running on this instance.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • Type — (String)

          EC2 instance type that defines the computing resources of this instance.

          Possible values include:
          • "t2.micro"
          • "t2.small"
          • "t2.medium"
          • "t2.large"
          • "c3.large"
          • "c3.xlarge"
          • "c3.2xlarge"
          • "c3.4xlarge"
          • "c3.8xlarge"
          • "c4.large"
          • "c4.xlarge"
          • "c4.2xlarge"
          • "c4.4xlarge"
          • "c4.8xlarge"
          • "c5.large"
          • "c5.xlarge"
          • "c5.2xlarge"
          • "c5.4xlarge"
          • "c5.9xlarge"
          • "c5.12xlarge"
          • "c5.18xlarge"
          • "c5.24xlarge"
          • "c5a.large"
          • "c5a.xlarge"
          • "c5a.2xlarge"
          • "c5a.4xlarge"
          • "c5a.8xlarge"
          • "c5a.12xlarge"
          • "c5a.16xlarge"
          • "c5a.24xlarge"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "r4.large"
          • "r4.xlarge"
          • "r4.2xlarge"
          • "r4.4xlarge"
          • "r4.8xlarge"
          • "r4.16xlarge"
          • "r5.large"
          • "r5.xlarge"
          • "r5.2xlarge"
          • "r5.4xlarge"
          • "r5.8xlarge"
          • "r5.12xlarge"
          • "r5.16xlarge"
          • "r5.24xlarge"
          • "r5a.large"
          • "r5a.xlarge"
          • "r5a.2xlarge"
          • "r5a.4xlarge"
          • "r5a.8xlarge"
          • "r5a.12xlarge"
          • "r5a.16xlarge"
          • "r5a.24xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
          • "m5.large"
          • "m5.xlarge"
          • "m5.2xlarge"
          • "m5.4xlarge"
          • "m5.8xlarge"
          • "m5.12xlarge"
          • "m5.16xlarge"
          • "m5.24xlarge"
          • "m5a.large"
          • "m5a.xlarge"
          • "m5a.2xlarge"
          • "m5a.4xlarge"
          • "m5a.8xlarge"
          • "m5a.12xlarge"
          • "m5a.16xlarge"
          • "m5a.24xlarge"
        • Status — (String)

          Current status of the instance. Possible statuses include the following:

          • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

          • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

          • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

          Possible values include:
          • "PENDING"
          • "ACTIVE"
          • "TERMINATING"
        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Location — (String)

          The fleet location of the instance, expressed as an AWS Region code, such as us-west-2.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeMatchmaking(params = {}, callback) ⇒ AWS.Request

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 (SNS) to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Service Reference:

Examples:

Calling the describeMatchmaking operation

var params = {
  TicketIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
gamelift.describeMatchmaking(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TicketIds — (Array<String>)

      A unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TicketList — (Array<map>)

        A collection of existing matchmaking ticket objects matching the request.

        • TicketId — (String)

          A unique identifier for a matchmaking ticket.

        • ConfigurationName — (String)

          Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

        • ConfigurationArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

        • Status — (String)

          Current status of the matchmaking request.

          • QUEUED -- The matchmaking request has been received and is currently waiting to be processed.

          • SEARCHING -- The matchmaking request is currently being processed.

          • REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

          • PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

          • COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

          • FAILED -- The matchmaking request was not completed.

          • CANCELLED -- The matchmaking request was canceled. This may be the result of a call to StopMatchmaking or a proposed match that one or more players failed to accept.

          • TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.

          Note: Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
          Possible values include:
          • "CANCELLED"
          • "COMPLETED"
          • "FAILED"
          • "PLACING"
          • "QUEUED"
          • "REQUIRES_ACCEPTANCE"
          • "SEARCHING"
          • "TIMED_OUT"
        • StatusReason — (String)

          Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

        • StatusMessage — (String)

          Additional information about the current status.

        • StartTime — (Date)

          Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • EndTime — (Date)

          Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Players — (Array<map>)

          A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

          • PlayerId — (String)

            A unique identifier for a player

          • PlayerAttributes — (map<map>)

            A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

            • S — (String)

              For single string values. Maximum string length is 100 characters.

            • N — (Float)

              For number values, expressed as double.

            • SL — (Array<String>)

              For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

            • SDM — (map<Float>)

              For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

          • Team — (String)

            Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

          • LatencyInMs — (map<Integer>)

            A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported.

            If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable.

        • GameSessionConnectionInfo — (map)

          Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. This parameter is not set when FlexMatch is being used without GameLift hosting.

          • GameSessionArn — (String)

            A unique identifier for the game session. Use the game session ID.

          • IpAddress — (String)

            The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • DnsName — (String)

            The DNS identifier assigned to the instance that is running the game session. Values have the following format:

            • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

            • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

            When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

          • Port — (Integer)

            The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • MatchedPlayerSessions — (Array<map>)

            A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

            • PlayerId — (String)

              A unique identifier for a player

            • PlayerSessionId — (String)

              A unique identifier for a player session

        • EstimatedWaitTime — (Integer)

          Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeMatchmakingConfigurations(params = {}, callback) ⇒ AWS.Request

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

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Examples:

Calling the describeMatchmakingConfigurations operation

var params = {
  Limit: 'NUMBER_VALUE',
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE',
  RuleSetName: 'STRING_VALUE'
};
gamelift.describeMatchmakingConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)

      A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.

    • RuleSetName — (String)

      A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.

    • Limit — (Integer)

      The 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.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Configurations — (Array<map>)

        A collection of requested matchmaking configurations.

        • Name — (String)

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

        • ConfigurationArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name>. In a GameLift configuration ARN, the resource ID matches the Name value.

        • Description — (String)

          A descriptive label that is associated with matchmaking configuration.

        • GameSessionQueueArns — (Array<String>)

          The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when FlexMatchMode is set to STANDALONE.

        • RequestTimeoutSeconds — (Integer)

          The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

        • AcceptanceTimeoutSeconds — (Integer)

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

        • AcceptanceRequired — (Boolean)

          A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

        • RuleSetName — (String)

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

        • RuleSetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

        • NotificationTarget — (String)

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

        • AdditionalPlayerCount — (Integer)

          The 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. This parameter is not used when FlexMatchMode is set to STANDALONE.

        • CustomEventData — (String)

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

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • GameProperties — (Array<map>)

          A 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. This parameter is not used when FlexMatchMode is set to STANDALONE.

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • GameSessionData — (String)

          A 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. This parameter is not used when FlexMatchMode is set to STANDALONE.

        • BackfillMode — (String)

          The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

          Possible values include:
          • "AUTOMATIC"
          • "MANUAL"
        • FlexMatchMode — (String)

          Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

          • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

          • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.

          Possible values include:
          • "STANDALONE"
          • "WITH_QUEUE"
      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeMatchmakingRuleSets(params = {}, callback) ⇒ AWS.Request

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

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Service Reference:

Examples:

Calling the describeMatchmakingRuleSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  Names: [
    'STRING_VALUE',
    /* more items */
  ],
  NextToken: 'STRING_VALUE'
};
gamelift.describeMatchmakingRuleSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Names — (Array<String>)

      A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.

    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RuleSets — (Array<map>)

        A collection of requested matchmaking rule set objects.

        • RuleSetName — (String)

          A unique identifier for the matchmaking rule set

        • RuleSetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value.

        • RuleSetBodyrequired — (String)

          A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describePlayerSessions(params = {}, callback) ⇒ AWS.Request

Retrieves properties for one or more player sessions.

This action can be used in the following ways:

  • To retrieve a specific player session, provide the player session ID only.

  • To retrieve all player sessions in a game session, provide the game session ID only.

  • To retrieve all player sessions for a specific player, provide a player ID only.

To request player sessions, specify either a player session ID, game session ID, or player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a PlayerSession object is returned for each session that matches the request.

Available in Amazon GameLift Local.

Related actions

CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the describePlayerSessions operation

var params = {
  GameSessionId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PlayerId: 'STRING_VALUE',
  PlayerSessionId: 'STRING_VALUE',
  PlayerSessionStatusFilter: 'STRING_VALUE'
};
gamelift.describePlayerSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameSessionId — (String)

      A unique identifier for the game session to retrieve player sessions for.

    • PlayerId — (String)

      A unique identifier for a player to retrieve player sessions for.

    • PlayerSessionId — (String)

      A unique identifier for a player session to retrieve.

    • PlayerSessionStatusFilter — (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)

      The 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.

    • NextToken — (String)

      A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PlayerSessions — (Array<map>)

        A collection of objects containing properties for each player session that matches the request.

        • PlayerSessionId — (String)

          A unique identifier for a player session.

        • PlayerId — (String)

          A unique identifier for a player that is associated with this player session.

        • GameSessionId — (String)

          A unique identifier for the game session that the player session is connected to.

        • FleetId — (String)

          A unique identifier for the fleet that the player's game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that the player's game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Status — (String)

          Current status of the player session.

          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).

          Possible values include:
          • "RESERVED"
          • "ACTIVE"
          • "COMPLETED"
          • "TIMEDOUT"
        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

        • PlayerData — (String)

          Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRuntimeConfiguration(params = {}, callback) ⇒ AWS.Request

Retrieves a fleet's runtime configuration settings. The runtime configuration tells GameLift which server processes to run (and how) on each instance in the fleet.

To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift fleets

Running multiple processes on a fleet

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Service Reference:

Examples:

Calling the describeRuntimeConfiguration operation

var params = {
  FleetId: 'STRING_VALUE' /* required */
};
gamelift.describeRuntimeConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RuntimeConfiguration — (map)

        Instructions that describe how server processes should be launched and maintained on each instance in the fleet.

        • ServerProcesses — (Array<map>)

          A collection of server process configurations that identify what server processes to run on each instance in a fleet.

          • LaunchPathrequired — (String)

            The location of a game build executable or the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

            • Windows (custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"

            • Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "/local/game/MyRealtimeScript.js"

          • Parameters — (String)

            An optional list of parameters to pass to the server executable or Realtime script on launch.

          • ConcurrentExecutionsrequired — (Integer)

            The number of server processes using this configuration that run concurrently on each instance.

        • MaxConcurrentGameSessionActivations — (Integer)

          The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

        • GameSessionActivationTimeoutSeconds — (Integer)

          The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeScalingPolicies(params = {}, callback) ⇒ AWS.Request

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 (StopFleetActions). This operation 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.

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

Service Reference:

Examples:

Calling the describeScalingPolicies operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  Location: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  StatusFilter: ACTIVE | UPDATE_REQUESTED | UPDATING | DELETE_REQUESTED | DELETING | DELETED | ERROR
};
gamelift.describeScalingPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.

    • StatusFilter — (String)

      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.

      Possible values include:
      • "ACTIVE"
      • "UPDATE_REQUESTED"
      • "UPDATING"
      • "DELETE_REQUESTED"
      • "DELETING"
      • "DELETED"
      • "ERROR"
    • Limit — (Integer)

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

    • NextToken — (String)

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

    • Location — (String)

      CONTENT TODO

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScalingPolicies — (Array<map>)

        A collection of objects containing the scaling policies matching the request.

        • FleetId — (String)

          A unique identifier for the fleet that is associated with this scaling policy.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • Name — (String)

          A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

        • Status — (String)

          Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.

          • ACTIVE -- The scaling policy can be used for auto-scaling a fleet.

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

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

          • DELETE_REQUESTED -- 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.

          Possible values include:
          • "ACTIVE"
          • "UPDATE_REQUESTED"
          • "UPDATING"
          • "DELETE_REQUESTED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • ScalingAdjustment — (Integer)

          Amount of adjustment to make, based on the scaling adjustment type.

        • ScalingAdjustmentType — (String)

          The type of adjustment to make to a fleet's instance count (see FleetCapacity):

          • ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

          • 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.

          Possible values include:
          • "ChangeInCapacity"
          • "ExactCapacity"
          • "PercentChangeInCapacity"
        • ComparisonOperator — (String)

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

          Possible values include:
          • "GreaterThanOrEqualToThreshold"
          • "GreaterThanThreshold"
          • "LessThanThreshold"
          • "LessThanOrEqualToThreshold"
        • Threshold — (Float)

          Metric value used to trigger a scaling event.

        • EvaluationPeriods — (Integer)

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

        • MetricName — (String)

          Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

          • 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.

          Possible values include:
          • "ActivatingGameSessions"
          • "ActiveGameSessions"
          • "ActiveInstances"
          • "AvailableGameSessions"
          • "AvailablePlayerSessions"
          • "CurrentPlayerSessions"
          • "IdleInstances"
          • "PercentAvailableGameSessions"
          • "PercentIdleInstances"
          • "QueueDepth"
          • "WaitTime"
        • PolicyType — (String)

          The 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.

          Possible values include:
          • "RuleBased"
          • "TargetBased"
        • TargetConfiguration — (map)

          An object that contains settings for a target-based scaling policy.

          • TargetValuerequired — (Float)

            Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

        • UpdateStatus — (String)

          The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

          Possible values include:
          • "PENDING_UPDATE"
        • Location — (String)

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeScript(params = {}, callback) ⇒ AWS.Request

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

CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task

Service Reference:

Examples:

Calling the describeScript operation

var params = {
  ScriptId: 'STRING_VALUE' /* required */
};
gamelift.describeScript(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ScriptId — (String)

      A unique identifier for the Realtime script to retrieve properties for. You can use either the script ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Script — (map)

        A set of properties describing the requested script.

        • ScriptId — (String)

          A unique identifier for the Realtime script

        • ScriptArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

        • Name — (String)

          A descriptive label that is associated with a script. Script names do not need to be unique.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique.

        • SizeOnDisk — (Integer)

          The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • StorageLocation — (map)

          The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.

          • Bucket — (String)

            An Amazon S3 bucket identifier. This is the name of the S3 bucket.

            Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
          • Key — (String)

            The name of the zip file that contains the build files or script files.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

          • ObjectVersion — (String)

            The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeVpcPeeringAuthorizations(params = {}, callback) ⇒ AWS.Request

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.

Related actions

CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task

Examples:

Calling the describeVpcPeeringAuthorizations operation

var params = {
};
gamelift.describeVpcPeeringAuthorizations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcPeeringAuthorizations — (Array<map>)

        A collection of objects that describe all valid VPC peering operations for the current AWS account.

        • GameLiftAwsAccountId — (String)

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

        • PeerVpcAwsAccountId — (String)

        • PeerVpcId — (String)

          A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

        • CreationTime — (Date)

          Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • ExpirationTime — (Date)

          Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeVpcPeeringConnections(params = {}, callback) ⇒ AWS.Request

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.

Related actions

CreateVpcPeeringAuthorization | DescribeVpcPeeringAuthorizations | DeleteVpcPeeringAuthorization | CreateVpcPeeringConnection | DescribeVpcPeeringConnections | DeleteVpcPeeringConnection | All APIs by task

Service Reference:

Examples:

Calling the describeVpcPeeringConnections operation

var params = {
  FleetId: 'STRING_VALUE'
};
gamelift.describeVpcPeeringConnections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet. You can use either the fleet ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VpcPeeringConnections — (Array<map>)

        A collection of VPC peering connection records that match the request.

        • FleetId — (String)

          A unique identifier for the fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet resource for this connection.

        • IpV4CidrBlock — (String)

          CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

        • VpcPeeringConnectionId — (String)

          A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.

        • Status — (map)

          The status information about the connection. Status indicates if a connection is pending, successful, or failed.

          • Code — (String)

            Code indicating the status of a VPC peering connection.

          • Message — (String)

            Additional messaging associated with the connection status.

        • PeerVpcId — (String)

          A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with GameLift Fleets.

        • GameLiftVpcId — (String)

          A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getGameSessionLogUrl(params = {}, callback) ⇒ AWS.Request

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

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

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the getGameSessionLogUrl operation

var params = {
  GameSessionId: 'STRING_VALUE' /* required */
};
gamelift.getGameSessionLogUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameSessionId — (String)

      A unique identifier for the game session to get logs for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PreSignedUrl — (String)

        Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getInstanceAccess(params = {}, callback) ⇒ AWS.Request

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned that contains the instance's IP address and a set of credentials.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task

Service Reference:

Examples:

Calling the getInstanceAccess operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE' /* required */
};
gamelift.getInstanceAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet that contains the instance you want access to. You can use either the fleet ID or ARN value. 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.

    • InstanceId — (String)

      A unique identifier for the instance you want to get access to. You can access an instance in any status.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InstanceAccess — (map)

        The connection information for a fleet instance, including IP address and access credentials.

        • FleetId — (String)

          A unique identifier for the fleet containing the instance being accessed.

        • InstanceId — (String)

          A unique identifier for the instance being accessed.

        • IpAddress — (String)

          IP address that is assigned to the instance.

        • OperatingSystem — (String)

          Operating system that is running on the instance.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • Credentials — (map)

          Credentials required to access the instance.

          • UserName — (String)

            User login string.

          • Secret — (String)

            Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it is a private key (which must be saved as a .pem file) for use with SSH.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAliases(params = {}, callback) ⇒ AWS.Request

Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Note: Returned aliases are not listed in any particular order.

Related actions

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Service Reference:

Examples:

Calling the listAliases operation

var params = {
  Limit: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  RoutingStrategyType: SIMPLE | TERMINAL
};
gamelift.listAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RoutingStrategyType — (String)

      The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing 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.

      Possible values include:
      • "SIMPLE"
      • "TERMINAL"
    • Name — (String)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Aliases — (Array<map>)

        A collection of alias resources that match the request parameters.

        • AliasId — (String)

          A unique identifier for the alias. Alias IDs are unique within a Region.

        • Name — (String)

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

        • AliasArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

        • Description — (String)

          A human-readable description of an alias.

        • RoutingStrategy — (map)

          The routing configuration, including routing type and fleet target, for the alias.

          • Type — (String)

            The type of routing strategy for the alias.

            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.

            Possible values include:
            • "SIMPLE"
            • "TERMINAL"
          • FleetId — (String)

            A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

          • Message — (String)

            The message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBuilds(params = {}, callback) ⇒ AWS.Request

Retrieves build resources 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.

Note: Build resources are not listed in any particular order.

Learn more

Upload a Custom Server Build

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

Service Reference:

Examples:

Calling the listBuilds operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: INITIALIZED | READY | FAILED
};
gamelift.listBuilds(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Status — (String)

      Build status to filter results by. To retrieve all builds, leave this parameter empty.

      Possible build statuses include the following:

      • 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.

      Possible values include:
      • "INITIALIZED"
      • "READY"
      • "FAILED"
    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Builds — (Array<map>)

        A collection of build resources that match the request.

        • BuildId — (String)

          A unique identifier for the build.

        • BuildArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

        • Name — (String)

          A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

        • Status — (String)

          Current status of the build.

          Possible build statuses include the following:

          • 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.

          Possible values include:
          • "INITIALIZED"
          • "READY"
          • "FAILED"
        • SizeOnDisk — (Integer)

          File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

        • OperatingSystem — (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.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFleets(params = {}, callback) ⇒ AWS.Request

Retrieves a collection of fleet resources in an AWS Region. You can call this operation to get fleets in a previously selected default Region (see https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.htmlor specify a Region in your request. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

This operation can be used in the following ways:

  • To get a list of all fleets in a Region, don't provide a build or script identifier.

  • To get a list of all fleets where a specific custom game build is deployed, provide the build ID.

  • To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a list of fleet IDs that match the request parameters is returned. A NextToken value is also returned if there are more result pages to retrieve.

Note: Fleet resources are not listed in a particular order.

Learn more

Setting up GameLift fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Service Reference:

Examples:

Calling the listFleets operation

var params = {
  BuildId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ScriptId: 'STRING_VALUE'
};
gamelift.listFleets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BuildId — (String)

      A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

    • ScriptId — (String)

      A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetIds — (Array<String>)

        A set of fleet IDs that match the list request. You can retrieve additional information about all returned fleets by passing this result set to a DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization call.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGameServerGroups(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers groups that exist in the current AWS account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the listGameServerGroups operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.listGameServerGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroups — (Array<map>)

        A collection of game server group objects that match the request.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listGameServers(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Service Reference:

Examples:

Calling the listGameServers operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortOrder: ASCENDING | DESCENDING
};
gamelift.listGameServers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

    • SortOrder — (String)

      Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServers — (Array<map>)

        A collection of game server objects that match the request.

        • GameServerGroupName — (String)

          A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

        • GameServerGroupArn — (String)

          The ARN identifier for the game server group where the game server is located.

        • GameServerId — (String)

          A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

        • InstanceId — (String)

          The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

        • ConnectionInfo — (String)

          The port and IP address that must be used to establish a client connection to the game server.

        • GameServerData — (String)

          A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

        • ClaimStatus — (String)

          Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

          Possible values include:
          • "CLAIMED"
        • UtilizationStatus — (String)

          Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

          • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

          • UTILIZED - The game server is currently hosting a game session with players.

          Possible values include:
          • "AVAILABLE"
          • "UTILIZED"
        • RegistrationTime — (Date)

          Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastClaimTime — (Date)

          Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

        • LastHealthCheckTime — (Date)

          Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listScripts(params = {}, callback) ⇒ AWS.Request

Retrieves script records for all Realtime scripts that are associated with the AWS account in use.

Learn more

Amazon GameLift Realtime Servers

Related actions

CreateScript | ListScripts | DescribeScript | UpdateScript | DeleteScript | All APIs by task

Service Reference:

Examples:

Calling the listScripts operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
gamelift.listScripts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Limit — (Integer)

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

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Scripts — (Array<map>)

        A set of properties describing the requested script.

        • ScriptId — (String)

          A unique identifier for the Realtime script

        • ScriptArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the ScriptId value.

        • Name — (String)

          A descriptive label that is associated with a script. Script names do not need to be unique.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique.

        • SizeOnDisk — (Integer)

          The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at "0".

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • StorageLocation — (map)

          The location in Amazon S3 where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.

          • Bucket — (String)

            An Amazon S3 bucket identifier. This is the name of the S3 bucket.

            Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
          • Key — (String)

            The name of the zip file that contains the build files or script files.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

          • ObjectVersion — (String)

            The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to organize AWS resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

  • Build

  • Script

  • Fleet

  • Alias

  • GameSessionQueue

  • MatchmakingConfiguration

  • MatchmakingRuleSet

To list tags for a resource, specify the unique ARN value for the resource.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related actions

TagResource | UntagResource | ListTagsForResource | All APIs by task

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
gamelift.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The collection of tags that have been assigned to the specified resource.

        • Keyrequired — (String)

          The key for a developer-defined key:value pair for tagging an AWS resource.

        • Valuerequired — (String)

          The value for a developer-defined key:value pair for tagging an AWS resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putScalingPolicy(params = {}, callback) ⇒ AWS.Request

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.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

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

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

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

Rule-based policy

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

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

A policy's rule statement has the following structure:

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

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

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

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

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

Service Reference:

Examples:

Calling the putScalingPolicy operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  MetricName: ActivatingGameSessions | ActiveGameSessions | ActiveInstances | AvailableGameSessions | AvailablePlayerSessions | CurrentPlayerSessions | IdleInstances | PercentAvailableGameSessions | PercentIdleInstances | QueueDepth | WaitTime, /* required */
  Name: 'STRING_VALUE', /* required */
  ComparisonOperator: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold,
  EvaluationPeriods: 'NUMBER_VALUE',
  PolicyType: RuleBased | TargetBased,
  ScalingAdjustment: 'NUMBER_VALUE',
  ScalingAdjustmentType: ChangeInCapacity | ExactCapacity | PercentChangeInCapacity,
  TargetConfiguration: {
    TargetValue: 'NUMBER_VALUE' /* required */
  },
  Threshold: 'NUMBER_VALUE'
};
gamelift.putScalingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

    • FleetId — (String)

      A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.

    • ScalingAdjustment — (Integer)

      Amount of adjustment to make, based on the scaling adjustment type.

    • ScalingAdjustmentType — (String)

      The type of adjustment to make to a fleet's instance count (see FleetCapacity):

      • ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

      • 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%.

      Possible values include:
      • "ChangeInCapacity"
      • "ExactCapacity"
      • "PercentChangeInCapacity"
    • Threshold — (Float)

      Metric value used to trigger a scaling event.

    • ComparisonOperator — (String)

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

      Possible values include:
      • "GreaterThanOrEqualToThreshold"
      • "GreaterThanThreshold"
      • "LessThanThreshold"
      • "LessThanOrEqualToThreshold"
    • EvaluationPeriods — (Integer)

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

    • MetricName — (String)

      Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

      • 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.

      Possible values include:
      • "ActivatingGameSessions"
      • "ActiveGameSessions"
      • "ActiveInstances"
      • "AvailableGameSessions"
      • "AvailablePlayerSessions"
      • "CurrentPlayerSessions"
      • "IdleInstances"
      • "PercentAvailableGameSessions"
      • "PercentIdleInstances"
      • "QueueDepth"
      • "WaitTime"
    • PolicyType — (String)

      The 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.

      Possible values include:
      • "RuleBased"
      • "TargetBased"
    • TargetConfiguration — (map)

      An object that contains settings for a target-based scaling policy.

      • TargetValuerequired — (Float)

        Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Name — (String)

        A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

registerGameServer(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. When a game client or service requests a game server by calling ClaimGameServer, this information is returned in the response.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Service Reference:

Examples:

Calling the registerGameServer operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  GameServerId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE', /* required */
  ConnectionInfo: 'STRING_VALUE',
  GameServerData: 'STRING_VALUE'
};
gamelift.registerGameServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

    • GameServerId — (String)

      A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

    • InstanceId — (String)

      The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

    • ConnectionInfo — (String)

      Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

    • GameServerData — (String)

      A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServer — (map)

        Object that describes the newly registered game server.

        • GameServerGroupName — (String)

          A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

        • GameServerGroupArn — (String)

          The ARN identifier for the game server group where the game server is located.

        • GameServerId — (String)

          A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

        • InstanceId — (String)

          The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

        • ConnectionInfo — (String)

          The port and IP address that must be used to establish a client connection to the game server.

        • GameServerData — (String)

          A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

        • ClaimStatus — (String)

          Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

          Possible values include:
          • "CLAIMED"
        • UtilizationStatus — (String)

          Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

          • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

          • UTILIZED - The game server is currently hosting a game session with players.

          Possible values include:
          • "AVAILABLE"
          • "UTILIZED"
        • RegistrationTime — (Date)

          Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastClaimTime — (Date)

          Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

        • LastHealthCheckTime — (Date)

          Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

requestUploadCredentials(params = {}, callback) ⇒ AWS.Request

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

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

Learn more

Create a Build with Files in S3

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

Service Reference:

Examples:

Calling the requestUploadCredentials operation

var params = {
  BuildId: 'STRING_VALUE' /* required */
};
gamelift.requestUploadCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BuildId — (String)

      A unique identifier for the build to get credentials for. You can use either the build ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UploadCredentials — (map)

        AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

        • AccessKeyId — (String)

          Temporary key allowing access to the Amazon GameLift S3 account.

        • SecretAccessKey — (String)

          Temporary secret key allowing access to the Amazon GameLift S3 account.

        • SessionToken — (String)

          Token used to associate a specific build ID with the files uploaded using these credentials.

      • StorageLocation — (map)

        Amazon S3 path and key, identifying where the game build files are stored.

        • Bucket — (String)

          An Amazon S3 bucket identifier. This is the name of the S3 bucket.

          Note: GameLift currently does not support uploading from Amazon S3 buckets with names that contain a dot (.).
        • Key — (String)

          The name of the zip file that contains the build files or script files.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

        • ObjectVersion — (String)

          The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file. If not set, the latest version of the file is retrieved.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resolveAlias(params = {}, callback) ⇒ AWS.Request

Retrieves the fleet ID that an alias is currently pointing to.

Related actions

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Service Reference:

Examples:

Calling the resolveAlias operation

var params = {
  AliasId: 'STRING_VALUE' /* required */
};
gamelift.resolveAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasId — (String)

      The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or ARN value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        The fleet identifier that the alias is pointing to.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) associated with the GameLift fleet resource that this alias points to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

resumeGameServerGroup(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Reinstates activity on a game server group after it has been suspended. A game server group might be suspended by theSuspendGameServerGroup operation, or it might be suspended involuntarily due to a configuration problem. In the second case, you can manually resume activity on the group once the configuration problem has been resolved. Refer to the game server group status and status reason for more information on why group activity is suspended.

To resume activity, specify a game server group ARN and the type of activity to be resumed. If successful, a GameServerGroup object is returned showing that the resumed activity is no longer listed in SuspendedActions.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the resumeGameServerGroup operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  ResumeActions: [ /* required */
    REPLACE_INSTANCE_TYPES,
    /* more items */
  ]
};
gamelift.resumeGameServerGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

    • ResumeActions — (Array<String>)

      The activity to resume for this game server group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroup — (map)

        An object that describes the game server group resource, with the SuspendedActions property updated to reflect the resumed activity.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

searchGameSessions(params = {}, callback) ⇒ AWS.Request

Retrieves all active game sessions that match a set of search criteria and sorts them into a specified order.

When searching for game sessions, you specify exactly where you want to search and provide a search filter expression, a sort expression, or both. A search request can search only one fleet, but it can search all of a fleet's locations.

This operation can be used in the following ways:

  • To search all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID. This approach returns game sessions in the fleet's home Region and all remote locations that fit the search criteria.

  • To search all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name. For location, you can specify a fleet's home Region or any remote location.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSession object is returned for each game session that matches the request. Search finds game sessions that are in ACTIVE status only. To retrieve information on game sessions in other statuses, use DescribeGameSessions.

You can search or sort by the following game session attributes:

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

  • gameSessionName -- Name assigned to a game session. 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.

Note: 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.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the searchGameSessions operation

var params = {
  AliasId: 'STRING_VALUE',
  FilterExpression: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE',
  Location: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  SortExpression: 'STRING_VALUE'
};
gamelift.searchGameSessions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

    • AliasId — (String)

      A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

    • Location — (String)

      A fleet location to search for game sessions. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

    • FilterExpression — (String)

      String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

      A filter expression can contain one or multiple conditions. Each condition consists of the following:

      • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

      • Comparator -- Valid comparators are: =, <>, <, >, <=, >=.

      • 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:

      1. =, <>, <, >, <=, >=

      2. Parentheses

      3. NOT

      4. AND

      5. 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".

    • SortExpression — (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:

      • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

      • Order -- Valid sort orders are ASC (ascending) and DESC (descending).

      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)

      The 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.

    • NextToken — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessions — (Array<map>)

        A collection of objects containing game session properties for each session that matches the request.

        • GameSessionId — (String)

          A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

        • Name — (String)

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

        • FleetId — (String)

          A unique identifier for the fleet that the game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • CurrentPlayerSessionCount — (Integer)

          Number of players currently in the game session.

        • MaximumPlayerSessionCount — (Integer)

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

        • Status — (String)

          Current status of the game session. A game session must have an ACTIVE status to have player sessions.

          Possible values include:
          • "ACTIVE"
          • "ACTIVATING"
          • "TERMINATED"
          • "TERMINATING"
          • "ERROR"
        • StatusReason — (String)

          Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

          Possible values include:
          • "INTERRUPTED"
        • GameProperties — (Array<map>)

          A 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. You can search for active game sessions based on this custom data with SearchGameSessions.

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • PlayerSessionCreationPolicy — (String)

          Indicates whether or not the game session is accepting new players.

          Possible values include:
          • "ACCEPT_ALL"
          • "DENY_ALL"
        • CreatorId — (String)

          A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

        • GameSessionData — (String)

          A 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.

        • MatchmakerData — (String)

          Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

        • Location — (String)

          The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

      • NextToken — (String)

        A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startFleetActions(params = {}, callback) ⇒ AWS.Request

Resumes certain types of activity on fleet instances that were suspended with StopFleetActions. For multi-location fleets, fleet actions are managed separately for each location. Currently, this operation is used to restart a fleet's auto-scaling activity.

This operation can be used in the following ways:

  • To restart actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to resume.

  • To restart actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to resume.

If successful, GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet location were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes.

Learn more

Setting up GameLift fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Service Reference:

Examples:

Calling the startFleetActions operation

var params = {
  Actions: [ /* required */
    AUTO_SCALING,
    /* more items */
  ],
  FleetId: 'STRING_VALUE', /* required */
  Location: 'STRING_VALUE'
};
gamelift.startFleetActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.

    • Actions — (Array<String>)

      List of actions to restart on the fleet.

    • Location — (String)

      The fleet location to restart fleet actions for. Specify a location in the form of an AWS Region code, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet to restart actions on.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startGameSessionPlacement(params = {}, callback) ⇒ AWS.Request

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 player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)

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

If successful, a new game session placement is created.

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

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the startGameSessionPlacement operation

var params = {
  GameSessionQueueName: 'STRING_VALUE', /* required */
  MaximumPlayerSessionCount: 'NUMBER_VALUE', /* required */
  PlacementId: 'STRING_VALUE', /* required */
  DesiredPlayerSessions: [
    {
      PlayerData: 'STRING_VALUE',
      PlayerId: 'STRING_VALUE'
    },
    /* more items */
  ],
  GameProperties: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  GameSessionData: 'STRING_VALUE',
  GameSessionName: 'STRING_VALUE',
  PlayerLatencies: [
    {
      LatencyInMilliseconds: 'NUMBER_VALUE',
      PlayerId: 'STRING_VALUE',
      RegionIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ]
};
gamelift.startGameSessionPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PlacementId — (String)

      A 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.

    • GameSessionQueueName — (String)

      Name of the queue to use to place the new game session. You can use either the queue name or ARN value.

    • GameProperties — (Array<map>)

      A 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).

      • Keyrequired — (String)

        The game property identifier.

      • Valuerequired — (String)

        The game property value.

    • MaximumPlayerSessionCount — (Integer)

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

    • GameSessionName — (String)

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

    • PlayerLatencies — (Array<map>)

      A set of values, expressed in milliseconds, that indicates 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.

      • PlayerId — (String)

        A unique identifier for a player associated with the latency data.

      • RegionIdentifier — (String)

        Name of the Region that is associated with the latency value.

      • LatencyInMilliseconds — (Float)

        Amount of time that represents the time lag experienced by the player when connected to the specified Region.

    • DesiredPlayerSessions — (Array<map>)

      Set of information on each player to create a player session for.

      • PlayerId — (String)

        A unique identifier for a player to associate with the player session.

      • PlayerData — (String)

        Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

    • GameSessionData — (String)

      A 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).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessionPlacement — (map)

        Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.

        • PlacementId — (String)

          A unique identifier for a game session placement.

        • GameSessionQueueName — (String)

          A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        • Status — (String)

          Current status of the game session placement request.

          • PENDING -- The placement request is currently in the queue waiting to be processed.

          • FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

          • CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

          • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

          • FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

          Possible values include:
          • "PENDING"
          • "FULFILLED"
          • "CANCELLED"
          • "TIMED_OUT"
          • "FAILED"
        • GameProperties — (Array<map>)

          A 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).

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • MaximumPlayerSessionCount — (Integer)

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

        • GameSessionName — (String)

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

        • GameSessionId — (String)

          A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

        • GameSessionArn — (String)

          Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.

        • GameSessionRegion — (String)

          Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

        • PlayerLatencies — (Array<map>)

          A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.

          • PlayerId — (String)

            A unique identifier for a player associated with the latency data.

          • RegionIdentifier — (String)

            Name of the Region that is associated with the latency value.

          • LatencyInMilliseconds — (Float)

            Amount of time that represents the time lag experienced by the player when connected to the specified Region.

        • StartTime — (Date)

          Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • EndTime — (Date)

          Time stamp indicating when this request was completed, canceled, or timed out.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

        • PlacedPlayerSessions — (Array<map>)

          A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

          • PlayerId — (String)

            A unique identifier for a player that is associated with this player session.

          • PlayerSessionId — (String)

            A unique identifier for a player session.

        • GameSessionData — (String)

          A 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).

        • MatchmakerData — (String)

          Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startMatchBackfill(params = {}, callback) ⇒ AWS.Request

Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.

When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSession identifier. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.

When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.

To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.

Learn more

Backfill existing games with FlexMatch

Matchmaking events (reference)

How GameLift FlexMatch works

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Service Reference:

Examples:

Calling the startMatchBackfill operation

var params = {
  ConfigurationName: 'STRING_VALUE', /* required */
  Players: [ /* required */
    {
      LatencyInMs: {
        '<NonEmptyString>': 'NUMBER_VALUE',
        /* '<NonEmptyString>': ... */
      },
      PlayerAttributes: {
        '<NonZeroAndMaxString>': {
          N: 'NUMBER_VALUE',
          S: 'STRING_VALUE',
          SDM: {
            '<NonZeroAndMaxString>': 'NUMBER_VALUE',
            /* '<NonZeroAndMaxString>': ... */
          },
          SL: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<NonZeroAndMaxString>': ... */
      },
      PlayerId: 'STRING_VALUE',
      Team: 'STRING_VALUE'
    },
    /* more items */
  ],
  GameSessionArn: 'STRING_VALUE',
  TicketId: 'STRING_VALUE'
};
gamelift.startMatchBackfill(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TicketId — (String)

      A 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.

    • ConfigurationName — (String)

      Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

    • GameSessionArn — (String)

      A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

    • Players — (Array<map>)

      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.

      • PlayerId — (String)

        A unique identifier for a player

      • PlayerAttributes — (map<map>)

        A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

        • S — (String)

          For single string values. Maximum string length is 100 characters.

        • N — (Float)

          For number values, expressed as double.

        • SL — (Array<String>)

          For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

        • SDM — (map<Float>)

          For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

      • Team — (String)

        Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

      • LatencyInMs — (map<Integer>)

        A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported.

        If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MatchmakingTicket — (map)

        Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

        • TicketId — (String)

          A unique identifier for a matchmaking ticket.

        • ConfigurationName — (String)

          Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

        • ConfigurationArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

        • Status — (String)

          Current status of the matchmaking request.

          • QUEUED -- The matchmaking request has been received and is currently waiting to be processed.

          • SEARCHING -- The matchmaking request is currently being processed.

          • REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

          • PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

          • COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

          • FAILED -- The matchmaking request was not completed.

          • CANCELLED -- The matchmaking request was canceled. This may be the result of a call to StopMatchmaking or a proposed match that one or more players failed to accept.

          • TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.

          Note: Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
          Possible values include:
          • "CANCELLED"
          • "COMPLETED"
          • "FAILED"
          • "PLACING"
          • "QUEUED"
          • "REQUIRES_ACCEPTANCE"
          • "SEARCHING"
          • "TIMED_OUT"
        • StatusReason — (String)

          Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

        • StatusMessage — (String)

          Additional information about the current status.

        • StartTime — (Date)

          Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • EndTime — (Date)

          Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Players — (Array<map>)

          A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

          • PlayerId — (String)

            A unique identifier for a player

          • PlayerAttributes — (map<map>)

            A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

            • S — (String)

              For single string values. Maximum string length is 100 characters.

            • N — (Float)

              For number values, expressed as double.

            • SL — (Array<String>)

              For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

            • SDM — (map<Float>)

              For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

          • Team — (String)

            Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

          • LatencyInMs — (map<Integer>)

            A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported.

            If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable.

        • GameSessionConnectionInfo — (map)

          Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. This parameter is not set when FlexMatch is being used without GameLift hosting.

          • GameSessionArn — (String)

            A unique identifier for the game session. Use the game session ID.

          • IpAddress — (String)

            The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • DnsName — (String)

            The DNS identifier assigned to the instance that is running the game session. Values have the following format:

            • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

            • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

            When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

          • Port — (Integer)

            The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • MatchedPlayerSessions — (Array<map>)

            A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

            • PlayerId — (String)

              A unique identifier for a player

            • PlayerSessionId — (String)

              A unique identifier for a player session

        • EstimatedWaitTime — (Integer)

          Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startMatchmaking(params = {}, callback) ⇒ AWS.Request

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include any player attributes that are required by the matchmaking configuration's rule set. If successful, a matchmaking ticket is returned with status set to QUEUED.

Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service (SNS), which is defined in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

How GameLift FlexMatch works

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Service Reference:

Examples:

Calling the startMatchmaking operation

var params = {
  ConfigurationName: 'STRING_VALUE', /* required */
  Players: [ /* required */
    {
      LatencyInMs: {
        '<NonEmptyString>': 'NUMBER_VALUE',
        /* '<NonEmptyString>': ... */
      },
      PlayerAttributes: {
        '<NonZeroAndMaxString>': {
          N: 'NUMBER_VALUE',
          S: 'STRING_VALUE',
          SDM: {
            '<NonZeroAndMaxString>': 'NUMBER_VALUE',
            /* '<NonZeroAndMaxString>': ... */
          },
          SL: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* '<NonZeroAndMaxString>': ... */
      },
      PlayerId: 'STRING_VALUE',
      Team: 'STRING_VALUE'
    },
    /* more items */
  ],
  TicketId: 'STRING_VALUE'
};
gamelift.startMatchmaking(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TicketId — (String)

      A 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.

    • ConfigurationName — (String)

      Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value.

    • Players — (Array<map>)

      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.

      • PlayerId — (String)

        A unique identifier for a player

      • PlayerAttributes — (map<map>)

        A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

        • S — (String)

          For single string values. Maximum string length is 100 characters.

        • N — (Float)

          For number values, expressed as double.

        • SL — (Array<String>)

          For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

        • SDM — (map<Float>)

          For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

      • Team — (String)

        Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

      • LatencyInMs — (map<Integer>)

        A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported.

        If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MatchmakingTicket — (map)

        Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.

        • TicketId — (String)

          A unique identifier for a matchmaking ticket.

        • ConfigurationName — (String)

          Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

        • ConfigurationArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift matchmaking configuration resource that is used with this ticket.

        • Status — (String)

          Current status of the matchmaking request.

          • QUEUED -- The matchmaking request has been received and is currently waiting to be processed.

          • SEARCHING -- The matchmaking request is currently being processed.

          • REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

          • PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

          • COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

          • FAILED -- The matchmaking request was not completed.

          • CANCELLED -- The matchmaking request was canceled. This may be the result of a call to StopMatchmaking or a proposed match that one or more players failed to accept.

          • TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.

          Note: Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.
          Possible values include:
          • "CANCELLED"
          • "COMPLETED"
          • "FAILED"
          • "PLACING"
          • "QUEUED"
          • "REQUIRES_ACCEPTANCE"
          • "SEARCHING"
          • "TIMED_OUT"
        • StatusReason — (String)

          Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

        • StatusMessage — (String)

          Additional information about the current status.

        • StartTime — (Date)

          Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • EndTime — (Date)

          Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • Players — (Array<map>)

          A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

          • PlayerId — (String)

            A unique identifier for a player

          • PlayerAttributes — (map<map>)

            A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

            • S — (String)

              For single string values. Maximum string length is 100 characters.

            • N — (Float)

              For number values, expressed as double.

            • SL — (Array<String>)

              For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

            • SDM — (map<Float>)

              For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

          • Team — (String)

            Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

          • LatencyInMs — (map<Integer>)

            A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for which latency is reported.

            If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the ticket is not matchable.

        • GameSessionConnectionInfo — (map)

          Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed. This parameter is not set when FlexMatch is being used without GameLift hosting.

          • GameSessionArn — (String)

            A unique identifier for the game session. Use the game session ID.

          • IpAddress — (String)

            The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • DnsName — (String)

            The DNS identifier assigned to the instance that is running the game session. Values have the following format:

            • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

            • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

            When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

          • Port — (Integer)

            The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

          • MatchedPlayerSessions — (Array<map>)

            A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

            • PlayerId — (String)

              A unique identifier for a player

            • PlayerSessionId — (String)

              A unique identifier for a player session

        • EstimatedWaitTime — (Integer)

          Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopFleetActions(params = {}, callback) ⇒ AWS.Request

Suspends certain types of activity in a fleet location. Currently, this operation is used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed separately for each location.

Stopping fleet actions has several potential purposes. It allows you to temporarily stop auto-scaling activity but retain your scaling policies for use in the future. For multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it for certain locations.

This operation can be used in the following ways:

  • To stop actions on instances in the fleet's home Region, provide a fleet ID and the type of actions to suspend.

  • To stop actions on instances in one of the fleet's remote locations, provide a fleet ID, a location name, and the type of actions to suspend.

If successful, GameLift no longer initiates scaling events except in response to manual changes using UpdateFleetCapacity. You can view a fleet's stopped actions using DescribeFleetAttributes or DescribeFleetLocationAttributes. Suspended activity can be restarted using StartFleetActions.

Learn more

Setting up GameLift Fleets

Related actions

CreateFleet | UpdateFleetCapacity | PutScalingPolicy | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetLocationAttributes | UpdateFleetAttributes | StopFleetActions | DeleteFleet | All APIs by task

Service Reference:

Examples:

Calling the stopFleetActions operation

var params = {
  Actions: [ /* required */
    AUTO_SCALING,
    /* more items */
  ],
  FleetId: 'STRING_VALUE', /* required */
  Location: 'STRING_VALUE'
};
gamelift.stopFleetActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.

    • Actions — (Array<String>)

      List of actions to suspend on the fleet.

    • Location — (String)

      The fleet location to stop fleet actions for. Specify a location in the form of an AWS Region code, such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet to stop actions on.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopGameSessionPlacement(params = {}, callback) ⇒ AWS.Request

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the stopGameSessionPlacement operation

var params = {
  PlacementId: 'STRING_VALUE' /* required */
};
gamelift.stopGameSessionPlacement(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PlacementId — (String)

      A unique identifier for a game session placement to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSessionPlacement — (map)

        Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

        • PlacementId — (String)

          A unique identifier for a game session placement.

        • GameSessionQueueName — (String)

          A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

        • Status — (String)

          Current status of the game session placement request.

          • PENDING -- The placement request is currently in the queue waiting to be processed.

          • FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

          • CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

          • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

          • FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.

          Possible values include:
          • "PENDING"
          • "FULFILLED"
          • "CANCELLED"
          • "TIMED_OUT"
          • "FAILED"
        • GameProperties — (Array<map>)

          A 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).

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • MaximumPlayerSessionCount — (Integer)

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

        • GameSessionName — (String)

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

        • GameSessionId — (String)

          A unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

        • GameSessionArn — (String)

          Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.

        • GameSessionRegion — (String)

          Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

        • PlayerLatencies — (Array<map>)

          A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to AWS Regions.

          • PlayerId — (String)

            A unique identifier for a player associated with the latency data.

          • RegionIdentifier — (String)

            Name of the Region that is associated with the latency value.

          • LatencyInMilliseconds — (Float)

            Amount of time that represents the time lag experienced by the player when connected to the specified Region.

        • StartTime — (Date)

          Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • EndTime — (Date)

          Time stamp indicating when this request was completed, canceled, or timed out.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

        • PlacedPlayerSessions — (Array<map>)

          A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

          • PlayerId — (String)

            A unique identifier for a player that is associated with this player session.

          • PlayerSessionId — (String)

            A unique identifier for a player session.

        • GameSessionData — (String)

          A 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).

        • MatchmakerData — (String)

          Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopMatchmaking(params = {}, callback) ⇒ AWS.Request

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

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

Note: If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a game client

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Service Reference:

Examples:

Calling the stopMatchmaking operation

var params = {
  TicketId: 'STRING_VALUE' /* required */
};
gamelift.stopMatchmaking(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TicketId — (String)

      A unique identifier for a matchmaking ticket.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

suspendGameServerGroup(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Temporarily stops activity on a game server group without terminating instances or the game server group. You can restart activity by calling ResumeGameServerGroup. You can suspend the following activity:

  • Instance type replacement - This activity evaluates the current game hosting viability of all Spot instance types that are defined for the game server group. It updates the Auto Scaling group to remove nonviable Spot Instance types, which have a higher chance of game server interruptions. It then balances capacity across the remaining viable Spot Instance types. When this activity is suspended, the Auto Scaling group continues with its current balance, regardless of viability. Instance protection, utilization metrics, and capacity scaling activities continue to be active.

To suspend activity, specify a game server group ARN and the type of activity to be suspended. If successful, a GameServerGroup object is returned showing that the activity is listed in SuspendedActions.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the suspendGameServerGroup operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  SuspendActions: [ /* required */
    REPLACE_INSTANCE_TYPES,
    /* more items */
  ]
};
gamelift.suspendGameServerGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

    • SuspendActions — (Array<String>)

      The activity to suspend for this game server group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroup — (map)

        An object that describes the game server group resource, with the SuspendedActions property updated to reflect the suspended activity.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns a tag to a GameLift resource. AWS resource tags provide an additional management tool set. You can use tags to organize resources, create IAM permissions policies to manage access to groups of resources, customize AWS cost breakdowns, etc. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

  • Build

  • Script

  • Fleet

  • Alias

  • GameSessionQueue

  • MatchmakingConfiguration

  • MatchmakingRuleSet

To add a tag to a resource, specify the unique ARN value for the resource and provide a tag list containing one or more tags. The operation succeeds even if the list includes tags that are already assigned to the specified resource.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related actions

TagResource | UntagResource | ListTagsForResource | All APIs by task

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
gamelift.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

    • Tags — (Array<map>)

      A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and structured as key-value pairs. The maximum tag limit may be lower than stated. See Tagging AWS Resources for actual tagging limits.

      • Keyrequired — (String)

        The key for a developer-defined key:value pair for tagging an AWS resource.

      • Valuerequired — (String)

        The value for a developer-defined key:value pair for tagging an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag that is assigned to a GameLift resource. Resource tags are used to organize AWS resources for a range of purposes. This operation handles the permissions necessary to manage tags for the following GameLift resource types:

  • Build

  • Script

  • Fleet

  • Alias

  • GameSessionQueue

  • MatchmakingConfiguration

  • MatchmakingRuleSet

To remove a tag from a resource, specify the unique ARN value for the resource and provide a string list containing one or more tags to be removed. This operation succeeds even if the list includes tags that are not currently assigned to the specified resource.

Learn more

Tagging AWS Resources in the AWS General Reference

AWS Tagging Strategies

Related actions

TagResource | UntagResource | ListTagsForResource | All APIs by task

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
gamelift.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) that is assigned to and uniquely identifies the GameLift resource that you want to remove tags from. GameLift resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or Describe operation for the resource type.

    • TagKeys — (Array<String>)

      A list of one or more tag keys to remove from the specified GameLift resource. An AWS resource can have only one tag with a specific tag key, so specifying the tag key identifies which tag to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAlias(params = {}, callback) ⇒ AWS.Request

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

Related actions

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Service Reference:

Examples:

Calling the updateAlias operation

var params = {
  AliasId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  RoutingStrategy: {
    FleetId: 'STRING_VALUE',
    Message: 'STRING_VALUE',
    Type: SIMPLE | TERMINAL
  }
};
gamelift.updateAlias(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AliasId — (String)

      A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.

    • Name — (String)

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

    • Description — (String)

      A human-readable description of the alias.

    • RoutingStrategy — (map)

      The routing configuration, including routing type and fleet target, for the alias.

      • Type — (String)

        The type of routing strategy for the alias.

        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.

        Possible values include:
        • "SIMPLE"
        • "TERMINAL"
      • FleetId — (String)

        A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

      • Message — (String)

        The message text to be used with a terminal routing strategy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Alias — (map)

        The updated alias resource.

        • AliasId — (String)

          A unique identifier for the alias. Alias IDs are unique within a Region.

        • Name — (String)

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

        • AliasArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift alias ARN, the resource ID matches the alias ID value.

        • Description — (String)

          A human-readable description of an alias.

        • RoutingStrategy — (map)

          The routing configuration, including routing type and fleet target, for the alias.

          • Type — (String)

            The type of routing strategy for the alias.

            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.

            Possible values include:
            • "SIMPLE"
            • "TERMINAL"
          • FleetId — (String)

            A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

          • Message — (String)

            The message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateBuild(params = {}, callback) ⇒ AWS.Request

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

Learn more

Upload a Custom Server Build

Related actions

CreateBuild | ListBuilds | DescribeBuild | UpdateBuild | DeleteBuild | All APIs by task

Service Reference:

Examples:

Calling the updateBuild operation

var params = {
  BuildId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE',
  Version: 'STRING_VALUE'
};
gamelift.updateBuild(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BuildId — (String)

      A unique identifier for the build to update. You can use either the build ID or ARN value.

    • Name — (String)

      A descriptive label that is associated with a build. Build names do not need to be unique.

    • Version — (String)

      Version information that is associated with a build or script. Version strings do not need to be unique.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Build — (map)

        The updated build resource.

        • BuildId — (String)

          A unique identifier for the build.

        • BuildArn — (String)

          The Amazon Resource Name (ARN) that is assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift build ARN, the resource ID matches the BuildId value.

        • Name — (String)

          A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

        • Version — (String)

          Version information that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

        • Status — (String)

          Current status of the build.

          Possible build statuses include the following:

          • 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.

          Possible values include:
          • "INITIALIZED"
          • "READY"
          • "FAILED"
        • SizeOnDisk — (Integer)

          File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

        • OperatingSystem — (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.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
          • "AMAZON_LINUX_2"
        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFleetAttributes(params = {}, callback) ⇒ AWS.Request

Updates a fleet's mutable attributes, including game session protection and resource creation limits.

To update fleet attributes, specify the fleet ID and the property values that you want to change.

If successful, an updated FleetAttributes object is returned.

Learn more

Setting up GameLift fleets

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Service Reference:

Examples:

Calling the updateFleetAttributes operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  MetricGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE',
  NewGameSessionProtectionPolicy: NoProtection | FullProtection,
  ResourceCreationLimitPolicy: {
    NewGameSessionsPerCreator: 'NUMBER_VALUE',
    PolicyPeriodInMinutes: 'NUMBER_VALUE'
  }
};
gamelift.updateFleetAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

    • Name — (String)

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

    • Description — (String)

      A human-readable description of a fleet.

    • NewGameSessionProtectionPolicy — (String)

      The 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.

      Possible values include:
      • "NoProtection"
      • "FullProtection"
    • ResourceCreationLimitPolicy — (map)

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

      • NewGameSessionsPerCreator — (Integer)

        The maximum number of game sessions that an individual can create during the policy period.

      • PolicyPeriodInMinutes — (Integer)

        The time span used in evaluating the resource creation limit policy.

    • MetricGroups — (Array<String>)

      The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFleetCapacity(params = {}, callback) ⇒ AWS.Request

Updates capacity settings for a fleet. For fleets with multiple locations, use this operation to manage capacity settings in each location individually. Fleet capacity determines the number of game sessions and players that can be hosted based on the fleet configuration. Use this operation to set the following fleet capacity properties:

  • Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set the fleet's capacity to a value outside of this range, whether the capacity is changed manually or through automatic scaling.

  • Desired capacity: Manually set the number of EC2 instances to be maintained in a fleet location. Before changing a fleet's desired capacity, you may want to call DescribeEC2InstanceLimits to get the maximum capacity of the fleet's EC2 instance type. Alternatively, consider using automatic scaling to adjust capacity based on player demand.

This operation can be used in the following ways:

  • To update capacity for a fleet's home Region, or if the fleet has no remote locations, omit the Location parameter. The fleet must be in ACTIVE status.

  • To update capacity for a fleet's remote location, include the Location parameter set to the location to be updated. The location must be in ACTIVE status.

If successful, capacity settings are updated immediately. In response a change in desired capacity, GameLift initiates steps to start new instances or terminate existing instances in the requested fleet location. This continues until the location's active instance count matches the new desired instance count. You can track a fleet's current capacity by calling DescribeFleetCapacity or DescribeFleetLocationCapacity. If the requested desired instance count is higher than the instance type's limit, the LimitExceeded exception occurs.

Learn more

Scaling fleet capacity

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Service Reference:

Examples:

Calling the updateFleetCapacity operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  DesiredInstances: 'NUMBER_VALUE',
  Location: 'STRING_VALUE',
  MaxSize: 'NUMBER_VALUE',
  MinSize: 'NUMBER_VALUE'
};
gamelift.updateFleetCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to update capacity settings for. You can use either the fleet ID or ARN value.

    • DesiredInstances — (Integer)

      The number of EC2 instances you want to maintain in the specified fleet location. This value must fall between the minimum and maximum size limits.

    • MinSize — (Integer)

      The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.

    • MaxSize — (Integer)

      The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.

    • Location — (String)

      The name of a remote location to update fleet capacity settings for, in the form of an AWS Region code such as us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that was updated.

      • FleetArn — (String)

        The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      • Location — (String)

        The remote location being updated, expressed as an AWS Region code, such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFleetPortSettings(params = {}, callback) ⇒ AWS.Request

Updates permissions that allow inbound traffic to connect to game sessions that are being hosted on instances in the fleet.

To update settings, specify the fleet ID to be updated and specify the changes to be made. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions.

If successful, the fleet ID for the updated fleet is returned. For fleets with remote locations, port setting updates can take time to propagate across all locations. You can check the status of updates in each location by calling DescribeFleetPortSettings with a location name.

Learn more

Setting up GameLift fleets

Related actions

CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task

Service Reference:

Examples:

Calling the updateFleetPortSettings operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  InboundPermissionAuthorizations: [
    {
      FromPort: 'NUMBER_VALUE', /* required */
      IpRange: 'STRING_VALUE', /* required */
      Protocol: TCP | UDP, /* required */
      ToPort: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ],
  InboundPermissionRevocations: [
    {
      FromPort: 'NUMBER_VALUE', /* required */
      IpRange: 'STRING_VALUE', /* required */
      Protocol: TCP | UDP, /* required */
      ToPort: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ]
};
gamelift.updateFleetPortSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FleetId — (String)

      A unique identifier for the fleet to update port settings for. You can use either the fleet ID or ARN value.

    • InboundPermissionAuthorizations — (Array<map>)

      A collection of port settings to be added to the fleet resource.

      • FromPortrequired — (Integer)

        A starting value for a range of allowed port numbers.

      • ToPortrequired — (Integer)

        An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

      • IpRangerequired — (String)

        A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".

      • Protocolrequired — (String)

        The network communication protocol used by the fleet.

        Possible values include:
        • "TCP"
        • "UDP"
    • InboundPermissionRevocations — (Array<map>)

      A collection of port settings to be removed from the fleet resource.

      • FromPortrequired — (Integer)

        A starting value for a range of allowed port numbers.

      • ToPortrequired — (Integer)

        An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

      • IpRangerequired — (String)

        A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "000.000.000.000/[subnet mask]" or optionally the shortened version "0.0.0.0/[subnet mask]".

      • Protocolrequired — (String)

        The network communication protocol used by the fleet.

        Possible values include:
        • "TCP"
        • "UDP"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FleetId — (String)

        A unique identifier for the fleet that was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGameServer(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Updates information about a registered game server to help GameLift FleetIQ to track game server availability. This operation is called by a game server process that is running on an instance in a game server group.

Use this operation to update the following types of game server information. You can make all three types of updates in the same request:

  • To update the game server's utilization status, identify the game server and game server group and specify the current utilization status. Use this status to identify when game servers are currently hosting games and when they are available to be claimed.

  • To report health status, identify the game server and game server group and set health check to HEALTHY. If a game server does not report health status for a certain length of time, the game server is no longer considered healthy. As a result, it will be eventually deregistered from the game server group to avoid affecting utilization metrics. The best practice is to report health every 60 seconds.

  • To change game server metadata, provide updated game server data.

Once a game server is successfully updated, the relevant statuses and timestamps are updated.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Service Reference:

Examples:

Calling the updateGameServer operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  GameServerId: 'STRING_VALUE', /* required */
  GameServerData: 'STRING_VALUE',
  HealthCheck: HEALTHY,
  UtilizationStatus: AVAILABLE | UTILIZED
};
gamelift.updateGameServer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

    • GameServerId — (String)

      A custom string that uniquely identifies the game server to update.

    • GameServerData — (String)

      A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

    • UtilizationStatus — (String)

      Indicates whether the game server is available or is currently hosting gameplay.

      Possible values include:
      • "AVAILABLE"
      • "UTILIZED"
    • HealthCheck — (String)

      Indicates health status of the game server. A request that includes this parameter updates the game server's LastHealthCheckTime timestamp.

      Possible values include:
      • "HEALTHY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServer — (map)

        Object that describes the newly updated game server.

        • GameServerGroupName — (String)

          A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

        • GameServerGroupArn — (String)

          The ARN identifier for the game server group where the game server is located.

        • GameServerId — (String)

          A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

        • InstanceId — (String)

          The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

        • ConnectionInfo — (String)

          The port and IP address that must be used to establish a client connection to the game server.

        • GameServerData — (String)

          A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

        • ClaimStatus — (String)

          Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

          Possible values include:
          • "CLAIMED"
        • UtilizationStatus — (String)

          Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

          • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

          • UTILIZED - The game server is currently hosting a game session with players.

          Possible values include:
          • "AVAILABLE"
          • "UTILIZED"
        • RegistrationTime — (Date)

          Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastClaimTime — (Date)

          Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server's status should revert to null.

        • LastHealthCheckTime — (Date)

          Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGameServerGroup(params = {}, callback) ⇒ AWS.Request

This operation is used with the GameLift FleetIQ solution and game server groups.

Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Service Reference:

Examples:

Calling the updateGameServerGroup operation

var params = {
  GameServerGroupName: 'STRING_VALUE', /* required */
  BalancingStrategy: SPOT_ONLY | SPOT_PREFERRED | ON_DEMAND_ONLY,
  GameServerProtectionPolicy: NO_PROTECTION | FULL_PROTECTION,
  InstanceDefinitions: [
    {
      InstanceType: c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge, /* required */
      WeightedCapacity: 'STRING_VALUE'
    },
    /* more items */
  ],
  RoleArn: 'STRING_VALUE'
};
gamelift.updateGameServerGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameServerGroupName — (String)

      A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

    • InstanceDefinitions — (Array<map>)

      An updated list of EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

      • InstanceTyperequired — (String)

        An EC2 instance type designation.

        Possible values include:
        • "c4.large"
        • "c4.xlarge"
        • "c4.2xlarge"
        • "c4.4xlarge"
        • "c4.8xlarge"
        • "c5.large"
        • "c5.xlarge"
        • "c5.2xlarge"
        • "c5.4xlarge"
        • "c5.9xlarge"
        • "c5.12xlarge"
        • "c5.18xlarge"
        • "c5.24xlarge"
        • "c5a.large"
        • "c5a.xlarge"
        • "c5a.2xlarge"
        • "c5a.4xlarge"
        • "c5a.8xlarge"
        • "c5a.12xlarge"
        • "c5a.16xlarge"
        • "c5a.24xlarge"
        • "r4.large"
        • "r4.xlarge"
        • "r4.2xlarge"
        • "r4.4xlarge"
        • "r4.8xlarge"
        • "r4.16xlarge"
        • "r5.large"
        • "r5.xlarge"
        • "r5.2xlarge"
        • "r5.4xlarge"
        • "r5.8xlarge"
        • "r5.12xlarge"
        • "r5.16xlarge"
        • "r5.24xlarge"
        • "r5a.large"
        • "r5a.xlarge"
        • "r5a.2xlarge"
        • "r5a.4xlarge"
        • "r5a.8xlarge"
        • "r5a.12xlarge"
        • "r5a.16xlarge"
        • "r5a.24xlarge"
        • "m4.large"
        • "m4.xlarge"
        • "m4.2xlarge"
        • "m4.4xlarge"
        • "m4.10xlarge"
        • "m5.large"
        • "m5.xlarge"
        • "m5.2xlarge"
        • "m5.4xlarge"
        • "m5.8xlarge"
        • "m5.12xlarge"
        • "m5.16xlarge"
        • "m5.24xlarge"
        • "m5a.large"
        • "m5a.xlarge"
        • "m5a.2xlarge"
        • "m5a.4xlarge"
        • "m5a.8xlarge"
        • "m5a.12xlarge"
        • "m5a.16xlarge"
        • "m5a.24xlarge"
      • WeightedCapacity — (String)

        Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

    • GameServerProtectionPolicy — (String)

      A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

      Possible values include:
      • "NO_PROTECTION"
      • "FULL_PROTECTION"
    • BalancingStrategy — (String)

      Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

      • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

      • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

      • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

      Possible values include:
      • "SPOT_ONLY"
      • "SPOT_PREFERRED"
      • "ON_DEMAND_ONLY"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameServerGroup — (map)

        An object that describes the game server group resource with updated properties.

        • GameServerGroupName — (String)

          A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

        • GameServerGroupArn — (String)

          A generated unique ID for the game server group.

        • RoleArn — (String)

          The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

        • InstanceDefinitions — (Array<map>)

          The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

          • InstanceTyperequired — (String)

            An EC2 instance type designation.

            Possible values include:
            • "c4.large"
            • "c4.xlarge"
            • "c4.2xlarge"
            • "c4.4xlarge"
            • "c4.8xlarge"
            • "c5.large"
            • "c5.xlarge"
            • "c5.2xlarge"
            • "c5.4xlarge"
            • "c5.9xlarge"
            • "c5.12xlarge"
            • "c5.18xlarge"
            • "c5.24xlarge"
            • "c5a.large"
            • "c5a.xlarge"
            • "c5a.2xlarge"
            • "c5a.4xlarge"
            • "c5a.8xlarge"
            • "c5a.12xlarge"
            • "c5a.16xlarge"
            • "c5a.24xlarge"
            • "r4.large"
            • "r4.xlarge"
            • "r4.2xlarge"
            • "r4.4xlarge"
            • "r4.8xlarge"
            • "r4.16xlarge"
            • "r5.large"
            • "r5.xlarge"
            • "r5.2xlarge"
            • "r5.4xlarge"
            • "r5.8xlarge"
            • "r5.12xlarge"
            • "r5.16xlarge"
            • "r5.24xlarge"
            • "r5a.large"
            • "r5a.xlarge"
            • "r5a.2xlarge"
            • "r5a.4xlarge"
            • "r5a.8xlarge"
            • "r5a.12xlarge"
            • "r5a.16xlarge"
            • "r5a.24xlarge"
            • "m4.large"
            • "m4.xlarge"
            • "m4.2xlarge"
            • "m4.4xlarge"
            • "m4.10xlarge"
            • "m5.large"
            • "m5.xlarge"
            • "m5.2xlarge"
            • "m5.4xlarge"
            • "m5.8xlarge"
            • "m5.12xlarge"
            • "m5.16xlarge"
            • "m5.24xlarge"
            • "m5a.large"
            • "m5a.xlarge"
            • "m5a.2xlarge"
            • "m5a.4xlarge"
            • "m5a.8xlarge"
            • "m5a.12xlarge"
            • "m5a.16xlarge"
            • "m5a.24xlarge"
          • WeightedCapacity — (String)

            Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon EC2 Auto Scaling User Guide. Default value is "1".

        • BalancingStrategy — (String)

          Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:

          • SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.

          • SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.

          • ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.

          Possible values include:
          • "SPOT_ONLY"
          • "SPOT_PREFERRED"
          • "ON_DEMAND_ONLY"
        • GameServerProtectionPolicy — (String)

          A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.

          Possible values include:
          • "NO_PROTECTION"
          • "FULL_PROTECTION"
        • AutoScalingGroupArn — (String)

          A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

        • Status — (String)

          The current status of the game server group. Possible statuses include:

          • NEW - GameLift FleetIQ has validated the CreateGameServerGroup() request.

          • ACTIVATING - GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.

          • ACTIVE - The game server group has been successfully created.

          • DELETE_SCHEDULED - A request to delete the game server group has been received.

          • DELETING - GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.

          • DELETED - The game server group has been successfully deleted.

          • ERROR - The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.

          Possible values include:
          • "NEW"
          • "ACTIVATING"
          • "ACTIVE"
          • "DELETE_SCHEDULED"
          • "DELETING"
          • "DELETED"
          • "ERROR"
        • StatusReason — (String)

          Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

        • SuspendedActions — (Array<String>)

          A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • LastUpdatedTime — (Date)

          A timestamp that indicates when this game server group was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGameSession(params = {}, callback) ⇒ AWS.Request

Updates the mutable properties of a game session.

To update a game session, specify the game session ID and the values you want to change.

If successful, the updated GameSession object is returned.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Service Reference:

Examples:

Calling the updateGameSession operation

var params = {
  GameSessionId: 'STRING_VALUE', /* required */
  MaximumPlayerSessionCount: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  PlayerSessionCreationPolicy: ACCEPT_ALL | DENY_ALL,
  ProtectionPolicy: NoProtection | FullProtection
};
gamelift.updateGameSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GameSessionId — (String)

      A unique identifier for the game session to update.

    • MaximumPlayerSessionCount — (Integer)

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

    • Name — (String)

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

    • PlayerSessionCreationPolicy — (String)

      A policy that determines whether the game session is accepting new players.

      Possible values include:
      • "ACCEPT_ALL"
      • "DENY_ALL"
    • ProtectionPolicy — (String)

      Game session protection policy to apply to this game session only.

      • 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.

      Possible values include:
      • "NoProtection"
      • "FullProtection"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GameSession — (map)

        The updated game session properties.

        • GameSessionId — (String)

          A unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

        • Name — (String)

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

        • FleetId — (String)

          A unique identifier for the fleet that the game session is running on.

        • FleetArn — (String)

          The Amazon Resource Name (ARN) associated with the GameLift fleet that this game session is running on.

        • CreationTime — (Date)

          A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • TerminationTime — (Date)

          A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

        • CurrentPlayerSessionCount — (Integer)

          Number of players currently in the game session.

        • MaximumPlayerSessionCount — (Integer)

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

        • Status — (String)

          Current status of the game session. A game session must have an ACTIVE status to have player sessions.

          Possible values include:
          • "ACTIVE"
          • "ACTIVATING"
          • "TERMINATED"
          • "TERMINATING"
          • "ERROR"
        • StatusReason — (String)

          Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

          Possible values include:
          • "INTERRUPTED"
        • GameProperties — (Array<map>)

          A 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. You can search for active game sessions based on this custom data with SearchGameSessions.

          • Keyrequired — (String)

            The game property identifier.

          • Valuerequired — (String)

            The game property value.

        • IpAddress — (String)

          The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • DnsName — (String)

          The DNS identifier assigned to the instance that is running the game session. Values have the following format:

          • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

          • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

          When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

        • Port — (Integer)

          The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

        • PlayerSessionCreationPolicy — (String)

          Indicates whether or not the game session is accepting new players.

          Possible values include:
          • "ACCEPT_ALL"
          • "DENY_ALL"
        • CreatorId — (String)

          A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

        • GameSessionData — (String)

          A 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.

        • MatchmakerData — (String)

          Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

        • Location — (String)

          The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an AWS Region code such as us-west-2.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGameSessionQueue(params = {}, callback) ⇒ AWS.Request

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

Learn more

Using Multi-Region Queues

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Service Reference:

Examp