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.

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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

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 all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

Matchmaking-related operations include:

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)

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

    • PlayerIds — (Array<String>)

      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.

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. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.

Alias-related operations include:

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'
};
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)

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

    • Description — (String)

      Human-readable description of an alias.

    • RoutingStrategy — (map)

      Object that specifies the fleet and routing type to use for the alias.

      • Type — (String)

        Type of routing strategy.

        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)

        Unique identifier for a fleet that the alias points to.

      • Message — (String)

        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)

        Object that describes the newly created alias record.

        • AliasId — (String)

          Unique identifier for an alias; alias IDs are unique within a region.

        • Name — (String)

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

        • AliasArn — (String)

          Unique identifier for an alias; alias ARNs are unique across all regions.

        • Description — (String)

          Human-readable description of an alias.

        • RoutingStrategy — (map)

          Alias configuration for the alias, including routing type and settings.

          • Type — (String)

            Type of routing strategy.

            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)

            Unique identifier for a fleet that the alias points to.

          • Message — (String)

            Message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          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)

          Time stamp indicating when 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 from a set of game server binary files stored in an Amazon Simple Storage Service (Amazon S3) location. To use this API call, create a .zip file containing all of the files for the build and store it in an Amazon S3 bucket under your AWS account. For help on packaging your build files and creating a build, see Uploading Your Game to Amazon GameLift.

Use this API action ONLY if you are storing your game build files in an Amazon S3 bucket. To create a build using files stored locally, use the CLI command upload-build , which uploads the build files from a file location you specify.

To create a new build using CreateBuild, identify the storage location and operating system of your game build. You also have the option of specifying a build name and version. If successful, this action creates a new build record with an unique build ID and in INITIALIZED status. Use the API call DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets to host your game.

Build-related operations include:

Service Reference:

Examples:

Calling the createBuild operation

var params = {
  Name: 'STRING_VALUE',
  OperatingSystem: WINDOWS_2012 | AMAZON_LINUX,
  StorageLocation: {
    Bucket: 'STRING_VALUE',
    Key: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE'
  },
  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)

      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 that is associated with this build. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

    • StorageLocation — (map)

      Amazon S3 location of the game build files to be uploaded. The S3 bucket must be owned by the same AWS account that you're using to manage Amazon GameLift. It also must in the same region that you want to create a new build in. Before calling CreateBuild with this location, you must allow Amazon GameLift to access your Amazon S3 bucket (see Create a Build with Files in Amazon S3).

      • Bucket — (String)

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

      • Key — (String)

        Name of the zip file containing your build files.

      • RoleArn — (String)

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

    • 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. If your game build contains multiple executables, they all must run on the same operating system.

      Possible values include:
      • "WINDOWS_2012"
      • "AMAZON_LINUX"

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 record, including a unique build ID and status.

        • BuildId — (String)

          Unique identifier for a build.

        • Name — (String)

          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 that is associated with this build. 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"
        • CreationTime — (Date)

          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 not currently in use.

        • 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 specified in the request.

        • Bucket — (String)

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

        • Key — (String)

          Name of the zip file containing your build files.

        • RoleArn — (String)

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

Returns:

  • (AWS.Request)

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

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

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.

To create a new fleet, you must specify the following: (1) fleet name, (2) build ID of an uploaded game build, (3) an EC2 instance type, and (4) a run-time configuration that describes which server processes to run on each instance in the fleet. (Although the run-time configuration is not a required parameter, the fleet cannot be successfully activated without it.)

You can also configure the new fleet with the following settings:

  • Fleet description

  • Access permissions for inbound traffic

  • Fleet-wide game session protection

  • Resource creation limit

If you use Amazon CloudWatch for metrics, you can add the new fleet to a metric group. This allows you to view aggregated metrics for a set of fleets. Once you specify a metric group, the new fleet's metrics are included in the metric group's data.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks:

  • Creates a fleet record and sets the status to NEW (followed by other statuses as the fleet is activated).

  • Sets the fleet's target capacity to 1 (desired instances), which causes Amazon GameLift to start one new EC2 instance.

  • Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds.

  • Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.

  • Sets the fleet's status to ACTIVE as soon as one server process in the fleet is ready to host a game session.

Fleet-related operations include:

Service Reference:

Examples:

Calling the createFleet operation

var params = {
  BuildId: 'STRING_VALUE', /* required */
  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 | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge, /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  EC2InboundPermissions: [
    {
      FromPort: 0, /* required */
      IpRange: 'STRING_VALUE', /* required */
      Protocol: TCP | UDP, /* required */
      ToPort: 0 /* required */
    },
    /* more items */
  ],
  LogPaths: [
    'STRING_VALUE',
    /* more items */
  ],
  MetricGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  NewGameSessionProtectionPolicy: NoProtection | FullProtection,
  ResourceCreationLimitPolicy: {
    NewGameSessionsPerCreator: 0,
    PolicyPeriodInMinutes: 0
  },
  RuntimeConfiguration: {
    GameSessionActivationTimeoutSeconds: 0,
    MaxConcurrentGameSessionActivations: 0,
    ServerProcesses: [
      {
        ConcurrentExecutions: 0, /* required */
        LaunchPath: 'STRING_VALUE', /* required */
        Parameters: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  ServerLaunchParameters: 'STRING_VALUE',
  ServerLaunchPath: 'STRING_VALUE'
};
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)

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

    • Description — (String)

      Human-readable description of a fleet.

    • BuildId — (String)

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

    • ServerLaunchPath — (String)

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

    • ServerLaunchParameters — (String)

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

    • LogPaths — (Array<String>)

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

    • EC2InstanceType — (String)

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

      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"
      • "r3.large"
      • "r3.xlarge"
      • "r3.2xlarge"
      • "r3.4xlarge"
      • "r3.8xlarge"
      • "m3.medium"
      • "m3.large"
      • "m3.xlarge"
      • "m3.2xlarge"
      • "m4.large"
      • "m4.xlarge"
      • "m4.2xlarge"
      • "m4.4xlarge"
      • "m4.10xlarge"
    • EC2InboundPermissions — (Array<map>)

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

      • FromPortrequired — (Integer)

        Starting value for a range of allowed port numbers.

      • ToPortrequired — (Integer)

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

      • IpRangerequired — (String)

        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)

        Network communication protocol used by the fleet.

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

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

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

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

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

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

      • ServerProcesses — (Array<map>)

        Collection of server process configurations that describe which server processes to run on each instance in a fleet.

        • LaunchPathrequired — (String)

          Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe".

        • Parameters — (String)

          Optional list of parameters to pass to the server executable on launch.

        • ConcurrentExecutionsrequired — (Integer)

          Number of server processes using this configuration to run concurrently on an instance.

      • MaxConcurrentGameSessionActivations — (Integer)

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

      • GameSessionActivationTimeoutSeconds — (Integer)

        Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.

    • ResourceCreationLimitPolicy — (map)

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

      • NewGameSessionsPerCreator — (Integer)

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

      • PolicyPeriodInMinutes — (Integer)

        Time span used in evaluating the resource creation limit policy.

    • MetricGroups — (Array<String>)

      Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

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)

        Properties for the newly created fleet.

        • FleetId — (String)

          Unique identifier for a fleet.

        • FleetArn — (String)

          Identifier for a fleet that is unique across all regions.

        • Description — (String)

          Human-readable description of the fleet.

        • Name — (String)

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

        • CreationTime — (Date)

          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)

          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 – Amazon GameLift is setting up the new fleet, creating new instances with the game build 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)

          Unique identifier for a build.

        • ServerLaunchPath — (String)

          Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

        • ServerLaunchParameters — (String)

          Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

        • LogPaths — (Array<String>)

          Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

        • NewGameSessionProtectionPolicy — (String)

          Type of game session protection to set for all new instances 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)

          Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

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

          Fleet policy to limit the number of game sessions an individual player can create over a span of time.

          • NewGameSessionsPerCreator — (Integer)

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

          • PolicyPeriodInMinutes — (Integer)

            Time span used in evaluating the resource creation limit policy.

        • MetricGroups — (Array<String>)

          Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

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. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

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

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

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

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

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

Available in Amazon GameLift Local.

Game-session-related operations include:

Service Reference:

Examples:

Calling the createGameSession operation

var params = {
  MaximumPlayerSessionCount: 0, /* 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',
  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)

      Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

    • AliasId — (String)

      Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

    • MaximumPlayerSessionCount — (Integer)

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

    • Name — (String)

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

    • GameProperties — (Array<map>)

      Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

      • Keyrequired — (String)

        Game property identifier.

      • Valuerequired — (String)

        Game property value.

    • CreatorId — (String)

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

    • 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. (A game session ID has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

    • IdempotencyToken — (String)

      Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ID 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)

      Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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:

      • GameSession — (map)

        Object that describes the newly created game session record.

        • GameSessionId — (String)

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

        • Name — (String)

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

        • FleetId — (String)

          Unique identifier for a fleet the game session is running on.

        • CreationTime — (Date)

          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)

          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)

          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"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • IpAddress — (String)

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

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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)

          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)

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

Returns:

  • (AWS.Request)

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

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

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

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

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

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

Queue-related operations include:

Service Reference:

Examples:

Calling the createGameSessionQueue operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Destinations: [
    {
      DestinationArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  PlayerLatencyPolicies: [
    {
      MaximumIndividualPlayerLatencyMilliseconds: 0,
      PolicyDurationSeconds: 0
    },
    /* more items */
  ],
  TimeoutInSeconds: 0
};
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)

      Descriptive label that is associated with game session queue. Queue names must be unique within each region.

    • TimeoutInSeconds — (Integer)

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

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

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

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

      • DestinationArn — (String)

        Amazon Resource Name (ARN) 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.

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)

        Object that describes the newly created game session queue.

        • Name — (String)

          Descriptive label that is associated with game session queue. Queue names must be unique within each region.

        • GameSessionQueueArn — (String)

          Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • TimeoutInSeconds — (Integer)

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

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

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

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

          • DestinationArn — (String)

            Amazon Resource Name (ARN) 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.

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. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking request (StartMatchmaking) specifies a configuration for the match and provides player attributes to support the configuration being used.

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

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

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

Operations related to match configurations and rule sets include:

Service Reference:

Examples:

Calling the createMatchmakingConfiguration operation

var params = {
  AcceptanceRequired: true || false, /* required */
  GameSessionQueueArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  RequestTimeoutSeconds: 0, /* required */
  RuleSetName: 'STRING_VALUE', /* required */
  AcceptanceTimeoutSeconds: 0,
  AdditionalPlayerCount: 0,
  CustomEventData: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  GameProperties: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  GameSessionData: 'STRING_VALUE',
  NotificationTarget: 'STRING_VALUE'
};
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)

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

    • Description — (String)

      Meaningful description of the matchmaking configuration.

    • GameSessionQueueArns — (Array<String>)

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

    • RequestTimeoutSeconds — (Integer)

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

    • AcceptanceTimeoutSeconds — (Integer)

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

    • AcceptanceRequired — (Boolean)

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

    • RuleSetName — (String)

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

    • NotificationTarget — (String)

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

    • AdditionalPlayerCount — (Integer)

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

    • CustomEventData — (String)

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

    • GameProperties — (Array<map>)

      Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

      • Keyrequired — (String)

        Game property identifier.

      • Valuerequired — (String)

        Game property value.

    • GameSessionData — (String)

      Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

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)

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

        • Description — (String)

          Descriptive label that is associated with matchmaking configuration.

        • GameSessionQueueArns — (Array<String>)

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

        • RequestTimeoutSeconds — (Integer)

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

        • AcceptanceTimeoutSeconds — (Integer)

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

        • AcceptanceRequired — (Boolean)

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

        • RuleSetName — (String)

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

        • NotificationTarget — (String)

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

        • AdditionalPlayerCount — (Integer)

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

        • CustomEventData — (String)

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

        • CreationTime — (Date)

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

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • GameSessionData — (String)

          Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

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

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

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

Operations related to match configurations and rule sets include:

Service Reference:

Examples:

Calling the createMatchmakingRuleSet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RuleSetBody: 'STRING_VALUE' /* required */
};
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)

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

    • RuleSetBody — (String)

      Collection of matchmaking rules, formatted as a JSON string. (Note that comments are not allowed in JSON, but most elements support a description field.)

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)

        Object that describes the newly created matchmaking rule set.

        • RuleSetName — (String)

          Unique identifier for a matchmaking rule set

        • RuleSetBodyrequired — (String)

          Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)

        • CreationTime — (Date)

          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

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

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

Available in Amazon GameLift Local.

Player-session-related operations include:

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)

      Unique identifier for the game session to add a player to.

    • PlayerId — (String)

      Unique identifier for a player. Player IDs are developer-defined.

    • PlayerData — (String)

      Developer-defined information related to a player. Amazon 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)

          Unique identifier for a player session.

        • PlayerId — (String)

          Unique identifier for a player that is associated with this player session.

        • GameSessionId — (String)

          Unique identifier for the game session that the player session is connected to.

        • FleetId — (String)

          Unique identifier for a fleet that the player's game session is running on.

        • CreationTime — (Date)

          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)

          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 time-out limit (60 seconds).

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

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

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

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

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

Available in Amazon GameLift Local.

Player-session-related operations include:

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)

      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. Player data strings for player IDs 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>)

        Collection of player session objects created for the added players.

        • PlayerSessionId — (String)

          Unique identifier for a player session.

        • PlayerId — (String)

          Unique identifier for a player that is associated with this player session.

        • GameSessionId — (String)

          Unique identifier for the game session that the player session is connected to.

        • FleetId — (String)

          Unique identifier for a fleet that the player's game session is running on.

        • CreationTime — (Date)

          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)

          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 time-out limit (60 seconds).

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

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

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

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

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

Alias-related operations include:

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)

      Unique identifier for a fleet alias. Specify the alias you want to delete.

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 action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. 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.

Build-related operations include:

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)

      Unique identifier for a build to delete.

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 everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

Fleet-related operations include:

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)

      Unique identifier for a fleet to be deleted.

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.

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

Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.

Queue-related operations include:

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)

      Descriptive label that is associated with game session queue. Queue names must be unique within each region.

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.

Operations related to match configurations and rule sets include:

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)

      Unique identifier for a matchmaking configuration

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. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

Fleet-related operations include:

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)

      Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

    • FleetId — (String)

      Unique identifier for a fleet to be deleted.

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.

Alias-related operations include:

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)

      Unique identifier for a fleet alias. Specify the alias you want 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:

      • Alias — (map)

        Object that contains the requested alias.

        • AliasId — (String)

          Unique identifier for an alias; alias IDs are unique within a region.

        • Name — (String)

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

        • AliasArn — (String)

          Unique identifier for an alias; alias ARNs are unique across all regions.

        • Description — (String)

          Human-readable description of an alias.

        • RoutingStrategy — (map)

          Alias configuration for the alias, including routing type and settings.

          • Type — (String)

            Type of routing strategy.

            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)

            Unique identifier for a fleet that the alias points to.

          • Message — (String)

            Message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          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)

          Time stamp indicating when 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 build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.

Build-related operations include:

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)

      Unique identifier for a build to retrieve properties 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:

      • Build — (map)

        Set of properties describing the requested build.

        • BuildId — (String)

          Unique identifier for a build.

        • Name — (String)

          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 that is associated with this build. 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"
        • CreationTime — (Date)

          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

Retrieves the following information for the specified EC2 instance type:

  • maximum number of instances allowed per AWS account (service limit)

  • current usage level for the AWS account

Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).

Fleet-related operations include:

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 | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge
};
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 Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.

      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"
      • "r3.large"
      • "r3.xlarge"
      • "r3.2xlarge"
      • "r3.4xlarge"
      • "r3.8xlarge"
      • "m3.medium"
      • "m3.large"
      • "m3.xlarge"
      • "m3.2xlarge"
      • "m4.large"
      • "m4.xlarge"
      • "m4.2xlarge"
      • "m4.4xlarge"
      • "m4.10xlarge"

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

        Object that contains the maximum number of instances for the specified instance type.

        • EC2InstanceType — (String)

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

          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"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
        • CurrentInstances — (Integer)

          Number of instances of the specified type that are currently in use by this AWS account.

        • InstanceLimit — (Integer)

          Number of instances allowed.

Returns:

  • (AWS.Request)

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

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

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

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the describeFleetAttributes operation

var params = {
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 0,
  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>)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects containing attribute metadata for each requested fleet ID.

        • FleetId — (String)

          Unique identifier for a fleet.

        • FleetArn — (String)

          Identifier for a fleet that is unique across all regions.

        • Description — (String)

          Human-readable description of the fleet.

        • Name — (String)

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

        • CreationTime — (Date)

          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)

          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 – Amazon GameLift is setting up the new fleet, creating new instances with the game build 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)

          Unique identifier for a build.

        • ServerLaunchPath — (String)

          Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

        • ServerLaunchParameters — (String)

          Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

        • LogPaths — (Array<String>)

          Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

        • NewGameSessionProtectionPolicy — (String)

          Type of game session protection to set for all new instances 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)

          Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

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

          Fleet policy to limit the number of game sessions an individual player can create over a span of time.

          • NewGameSessionsPerCreator — (Integer)

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

          • PolicyPeriodInMinutes — (Integer)

            Time span used in evaluating the resource creation limit policy.

        • MetricGroups — (Array<String>)

          Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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 current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the describeFleetCapacity operation

var params = {
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 0,
  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>)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.

        • FleetId — (String)

          Unique identifier for a fleet.

        • InstanceType — (String)

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

          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"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
        • InstanceCounts — (map)

          Current status of fleet capacity.

          • DESIRED — (Integer)

            Ideal number of active instances in the fleet.

          • MINIMUM — (Integer)

            Minimum value allowed for the fleet's instance count.

          • MAXIMUM — (Integer)

            Maximum value allowed for the fleet's instance count.

          • PENDING — (Integer)

            Number of instances in the fleet that are starting but not yet active.

          • ACTIVE — (Integer)

            Actual number of active instances in the fleet.

          • IDLE — (Integer)

            Number of active instances in the fleet that are not currently hosting a game session.

          • TERMINATING — (Integer)

            Number of instances in the fleet that are no longer active but haven't yet been terminated.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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 the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Fleet-related operations include:

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: 0,
  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)

      Unique identifier for a fleet to get event logs for.

    • StartTime — (Date)

      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)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects containing event log entries for the specified fleet.

        • EventId — (String)

          Unique identifier for a fleet event.

        • ResourceId — (String)

          Unique identifier for an event resource, such as a fleet ID.

        • EventCode — (String)

          Type of event being logged. The following events are currently in use:

          • General events:

            • GENERIC_EVENT – An unspecified event has occurred.

          • Fleet creation events:

            • FLEET_CREATED – A fleet record 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 Amazon 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 Amazon GameLift is now verifying that the game server launch paths, which are specified in the fleet's run-time configuration, exist. If any listed launch path exists, Amazon 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 run-time 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 run-time 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 run-time 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. A possible reason for failure is that the game server is not reporting "process ready" to the Amazon GameLift service.

            • FLEET_STATE_ACTIVE – The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.

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

          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"
        • 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 Amazon GameLift console.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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.

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

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the describeFleetPortSettings operation

var params = {
  FleetId: 'STRING_VALUE' /* required */
};
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)

      Unique identifier for a fleet to retrieve port settings 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:

      • InboundPermissions — (Array<map>)

        Object that contains port settings for the requested fleet ID.

        • FromPortrequired — (Integer)

          Starting value for a range of allowed port numbers.

        • ToPortrequired — (Integer)

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

        • IpRangerequired — (String)

          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)

          Network communication protocol used by the fleet.

          Possible values include:
          • "TCP"
          • "UDP"

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

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the describeFleetUtilization operation

var params = {
  FleetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Limit: 0,
  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>)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects containing utilization information for each requested fleet ID.

        • FleetId — (String)

          Unique identifier for a fleet.

        • ActiveServerProcessCount — (Integer)

          Number of server processes in an ACTIVE status currently running across all instances in the fleet

        • ActiveGameSessionCount — (Integer)

          Number of active game sessions currently being hosted on all instances in the fleet.

        • CurrentPlayerSessionCount — (Integer)

          Number of active player sessions currently being hosted on all instances in the fleet.

        • MaximumPlayerSessionCount — (Integer)

          Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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 properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

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

Game-session-related operations include:

Service Reference:

Examples:

Calling the describeGameSessionDetails operation

var params = {
  AliasId: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  GameSessionId: 'STRING_VALUE',
  Limit: 0,
  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)

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

    • GameSessionId — (String)

      Unique identifier for the game session to retrieve.

    • AliasId — (String)

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

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

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

    • NextToken — (String)

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

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

        Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

        • GameSession — (map)

          Object that describes a game session.

          • GameSessionId — (String)

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

          • Name — (String)

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

          • FleetId — (String)

            Unique identifier for a fleet the game session is running on.

          • CreationTime — (Date)

            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)

            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)

            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"
          • GameProperties — (Array<map>)

            Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

            • Keyrequired — (String)

              Game property identifier.

            • Valuerequired — (String)

              Game property value.

          • IpAddress — (String)

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

          • Port — (Integer)

            Port number for the game session. To connect to a Amazon 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)

            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)

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

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

        Token that indicates where to resume retrieving results on the next call to this action. 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 properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.

Game-session-related operations include:

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)

      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)

          Unique identifier for a game session placement.

        • GameSessionQueueName — (String)

          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.

          Possible values include:
          • "PENDING"
          • "FULFILLED"
          • "CANCELLED"
          • "TIMED_OUT"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • MaximumPlayerSessionCount — (Integer)

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

        • GameSessionName — (String)

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

        • GameSessionId — (String)

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

          Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

          • PlayerId — (String)

            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)

          IP address of the game session. To connect to a Amazon 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).

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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>)

          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)

            Unique identifier for a player that is associated with this player session.

          • PlayerSessionId — (String)

            Unique identifier for a player session.

        • GameSessionData — (String)

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

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.

Queue-related operations include:

Service Reference:

Examples:

Calling the describeGameSessionQueues operation

var params = {
  Limit: 0,
  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>)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects that describes the requested game session queues.

        • Name — (String)

          Descriptive label that is associated with game session queue. Queue names must be unique within each region.

        • GameSessionQueueArn — (String)

          Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • TimeoutInSeconds — (Integer)

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

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

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

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

          • DestinationArn — (String)

            Amazon Resource Name (ARN) 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.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

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

Available in Amazon GameLift Local.

Game-session-related operations include:

Service Reference:

Examples:

Calling the describeGameSessions operation

var params = {
  AliasId: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  GameSessionId: 'STRING_VALUE',
  Limit: 0,
  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)

      Unique identifier for a fleet to retrieve all game sessions for.

    • GameSessionId — (String)

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

    • AliasId — (String)

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

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

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

    • NextToken — (String)

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

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

        Collection of objects containing game session properties for each session matching the request.

        • GameSessionId — (String)

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

        • Name — (String)

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

        • FleetId — (String)

          Unique identifier for a fleet the game session is running on.

        • CreationTime — (Date)

          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)

          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)

          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"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • IpAddress — (String)

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

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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)

          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)

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

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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. Use this action to get details on all instances in the fleet or get details on one specific instance.

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

Service Reference:

Examples:

Calling the describeInstances operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  InstanceId: 'STRING_VALUE',
  Limit: 0,
  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)

      Unique identifier for a fleet to retrieve instance information for.

    • InstanceId — (String)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects containing properties for each instance returned.

        • FleetId — (String)

          Unique identifier for a fleet that the instance is in.

        • InstanceId — (String)

          Unique identifier for an instance.

        • IpAddress — (String)

          IP address assigned to the instance.

        • OperatingSystem — (String)

          Operating system that is running on this instance.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
        • 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"
          • "r3.large"
          • "r3.xlarge"
          • "r3.2xlarge"
          • "r3.4xlarge"
          • "r3.8xlarge"
          • "m3.medium"
          • "m3.large"
          • "m3.xlarge"
          • "m3.2xlarge"
          • "m4.large"
          • "m4.xlarge"
          • "m4.2xlarge"
          • "m4.4xlarge"
          • "m4.10xlarge"
        • 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 Amazon 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)

          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)

        Token that indicates where to resume retrieving results on the next call to this action. 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 a set of one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

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

You can request data for a one or a list of ticket IDs. If the request is successful, a ticket object is returned for each requested ID. When specifying a list of ticket IDs, objects are returned only for tickets that currently exist.

Matchmaking-related operations include:

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

      Unique identifier for a matchmaking ticket. To request all existing tickets, leave this parameter empty.

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

        Collection of existing matchmaking ticket objects matching the request.

        • TicketId — (String)

          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.

        • 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. Tickets with players who fail to accept a proposed match are placed in FAILED status; new matchmaking requests can be submitted for these players.

          • CANCELLED – The matchmaking request was canceled with a call to StopMatchmaking.

          • TIMED_OUT – The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.

          Possible values include:
          • "CANCELED"
          • "COMPLETE"
          • "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").

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

            Unique identifier for a player

          • PlayerAttributes — (map<map>)

            Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. 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 occurances of the the repeated value after the first of a repeated value are ignored.

            • SDM — (map<Float>)

              For a map of up to 10 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>)

            Set of values, expressed in milliseconds, indicating 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 that are included in the object map. If not present (that is, null), FlexMatch ignores latency issues and may place the match in any region in the queue.

            Note: If this property contains an empty map, FlexMatch assumes that no regions are available to the player. In this scenario, the ticket is not matchable and always times out unless canceled.
        • 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.

          • GameSessionArn — (String)

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

          • IpAddress — (String)

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

          • Port — (Integer)

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

          • MatchedPlayerSessions — (Array<map>)

            Collection of player session IDs, one for each player ID that was included in the original matchmaking request.

            • PlayerId — (String)

              Unique identifier for a player

            • PlayerSessionId — (String)

              Unique identifier for a player session

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. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Operations related to match configurations and rule sets include:

Examples:

Calling the describeMatchmakingConfigurations operation

var params = {
  Limit: 0,
  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>)

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

    • RuleSetName — (String)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of requested matchmaking configuration objects.

        • Name — (String)

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

        • Description — (String)

          Descriptive label that is associated with matchmaking configuration.

        • GameSessionQueueArns — (Array<String>)

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

        • RequestTimeoutSeconds — (Integer)

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

        • AcceptanceTimeoutSeconds — (Integer)

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

        • AcceptanceRequired — (Boolean)

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

        • RuleSetName — (String)

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

        • NotificationTarget — (String)

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

        • AdditionalPlayerCount — (Integer)

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

        • CustomEventData — (String)

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

        • CreationTime — (Date)

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

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • GameSessionData — (String)

          Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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.

Operations related to match configurations and rule sets include:

Service Reference:

Examples:

Calling the describeMatchmakingRuleSets operation

var params = {
  Limit: 0,
  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>)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of requested matchmaking rule set objects.

        • RuleSetName — (String)

          Unique identifier for a matchmaking rule set

        • RuleSetBodyrequired — (String)

          Collection of matchmaking rules, formatted as a JSON string. (Note that comments14 are not allowed in JSON, but most elements support a description field.)

        • CreationTime — (Date)

          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)

        Token that indicates where to resume retrieving results on the next call to this action. 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 several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

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

Available in Amazon GameLift Local.

Player-session-related operations include:

Service Reference:

Examples:

Calling the describePlayerSessions operation

var params = {
  GameSessionId: 'STRING_VALUE',
  Limit: 0,
  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)

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

    • PlayerId — (String)

      Unique identifier for a player to retrieve player sessions for.

    • PlayerSessionId — (String)

      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 time-out limit (60 seconds).

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of objects containing properties for each player session that matches the request.

        • PlayerSessionId — (String)

          Unique identifier for a player session.

        • PlayerId — (String)

          Unique identifier for a player that is associated with this player session.

        • GameSessionId — (String)

          Unique identifier for the game session that the player session is connected to.

        • FleetId — (String)

          Unique identifier for a fleet that the player's game session is running on.

        • CreationTime — (Date)

          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)

          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 time-out limit (60 seconds).

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

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

        • 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. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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 the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.

Fleet-related operations include:

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)

      Unique identifier for a fleet to get the run-time configuration 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:

      • RuntimeConfiguration — (map)

        Instructions describing how server processes should be launched and maintained on each instance in the fleet.

        • ServerProcesses — (Array<map>)

          Collection of server process configurations that describe which server processes to run on each instance in a fleet.

          • LaunchPathrequired — (String)

            Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe".

          • Parameters — (String)

            Optional list of parameters to pass to the server executable on launch.

          • ConcurrentExecutionsrequired — (Integer)

            Number of server processes using this configuration to run concurrently on an instance.

        • MaxConcurrentGameSessionActivations — (Integer)

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

        • GameSessionActivationTimeoutSeconds — (Integer)

          Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated 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.

Fleet-related operations include:

Service Reference:

Examples:

Calling the describeScalingPolicies operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  Limit: 0,
  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)

      Unique identifier for a fleet to retrieve scaling policies for.

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

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

    • NextToken — (String)

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

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

        Collection of objects containing the scaling policies matching the request.

        • FleetId — (String)

          Unique identifier for a fleet that is associated with this scaling policy.

        • Name — (String)

          Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

        • Status — (String)

          Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE status.

          • ACTIVE – The scaling policy is currently in force.

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

          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 an adjustment.

          • ActivatingGameSessions – number of game sessions in the process of being created (game session status = ACTIVATING).

          • ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE).

          • CurrentPlayerSessions – number of active or reserved player sessions (player session status = ACTIVE or RESERVED).

          • AvailablePlayerSessions – number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number does include game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).

          • ActiveInstances – number of instances currently running a game session.

          • IdleInstances – number of instances not currently running a game session.

          Possible values include:
          • "ActivatingGameSessions"
          • "ActiveGameSessions"
          • "ActiveInstances"
          • "AvailableGameSessions"
          • "AvailablePlayerSessions"
          • "CurrentPlayerSessions"
          • "IdleInstances"
          • "PercentAvailableGameSessions"
          • "PercentIdleInstances"
          • "QueueDepth"
          • "WaitTime"
      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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.

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

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

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

Game-session-related operations include:

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)

      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.

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 watching activity in real time.

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

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

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)

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

    • InstanceId — (String)

      Unique identifier for an 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)

        Object that contains connection information for a fleet instance, including IP address and access credentials.

        • FleetId — (String)

          Unique identifier for a fleet containing the instance being accessed.

        • InstanceId — (String)

          Unique identifier for an instance being accessed.

        • IpAddress — (String)

          IP address assigned to the instance.

        • OperatingSystem — (String)

          Operating system that is running on the instance.

          Possible values include:
          • "WINDOWS_2012"
          • "AMAZON_LINUX"
        • 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.

Alias-related operations include:

Service Reference:

Examples:

Calling the listAliases operation

var params = {
  Limit: 0,
  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)

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

      Possible routing types include the following:

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

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

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

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Collection of alias records that match the list request.

        • AliasId — (String)

          Unique identifier for an alias; alias IDs are unique within a region.

        • Name — (String)

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

        • AliasArn — (String)

          Unique identifier for an alias; alias ARNs are unique across all regions.

        • Description — (String)

          Human-readable description of an alias.

        • RoutingStrategy — (map)

          Alias configuration for the alias, including routing type and settings.

          • Type — (String)

            Type of routing strategy.

            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)

            Unique identifier for a fleet that the alias points to.

          • Message — (String)

            Message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          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)

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

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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 records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Note: Build records are not listed in any particular order.

Build-related operations include:

Service Reference:

Examples:

Calling the listBuilds operation

var params = {
  Limit: 0,
  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)

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

    • NextToken — (String)

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

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

        Collection of build records that match the request.

        • BuildId — (String)

          Unique identifier for a build.

        • Name — (String)

          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 that is associated with this build. 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"
        • CreationTime — (Date)

          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)

        Token that indicates where to resume retrieving results on the next call to this action. 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 records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Note: Fleet records are not listed in any particular order.

Fleet-related operations include:

Service Reference:

Examples:

Calling the listFleets operation

var params = {
  BuildId: 'STRING_VALUE',
  Limit: 0,
  NextToken: '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)

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

    • Limit — (Integer)

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

    • NextToken — (String)

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

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

        Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization.

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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.

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

Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.

A scaling policy rule statement has the following structure:

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

For example, this policy: "If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances" could be implemented as the following rule statement:

If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.

Fleet-related operations include:

Service Reference:

Examples:

Calling the putScalingPolicy operation

var params = {
  ComparisonOperator: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold, /* required */
  EvaluationPeriods: 0, /* required */
  FleetId: 'STRING_VALUE', /* required */
  MetricName: ActivatingGameSessions | ActiveGameSessions | ActiveInstances | AvailableGameSessions | AvailablePlayerSessions | CurrentPlayerSessions | IdleInstances | PercentAvailableGameSessions | PercentIdleInstances | QueueDepth | WaitTime, /* required */
  Name: 'STRING_VALUE', /* required */
  ScalingAdjustment: 0, /* required */
  ScalingAdjustmentType: ChangeInCapacity | ExactCapacity | PercentChangeInCapacity, /* required */
  Threshold: 0.0 /* required */
};
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)

      Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

    • FleetId — (String)

      Unique identifier for a fleet to apply this policy to.

    • ScalingAdjustment — (Integer)

      Amount of adjustment to make, based on the scaling adjustment type.

    • ScalingAdjustmentType — (String)

      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 an adjustment.

      • ActivatingGameSessions – number of game sessions in the process of being created (game session status = ACTIVATING).

      • ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE).

      • CurrentPlayerSessions – number of active or reserved player sessions (player session status = ACTIVE or RESERVED).

      • AvailablePlayerSessions – number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number includes game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).

      • ActiveInstances – number of instances currently running a game session.

      • IdleInstances – number of instances not currently running a game session.

      Possible values include:
      • "ActivatingGameSessions"
      • "ActiveGameSessions"
      • "ActiveInstances"
      • "AvailableGameSessions"
      • "AvailablePlayerSessions"
      • "CurrentPlayerSessions"
      • "IdleInstances"
      • "PercentAvailableGameSessions"
      • "PercentIdleInstances"
      • "QueueDepth"
      • "WaitTime"

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)

        Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

Returns:

  • (AWS.Request)

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

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

This API call is not currently in use. Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.

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)

      Unique identifier for a build to get credentials 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:

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

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

        • Key — (String)

          Name of the zip file containing your build files.

        • RoleArn — (String)

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

Returns:

  • (AWS.Request)

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

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

Retrieves the fleet ID that a specified alias is currently pointing to.

Alias-related operations include:

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)

      Unique identifier for the alias you want to resolve.

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)

        Fleet identifier that is associated with the requested alias.

Returns:

  • (AWS.Request)

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

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

Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. A game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.

You can search or sort by the following game session attributes:

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

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

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

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

  • hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. When searching with this attribute, the search value must be true or false. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

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

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.

Game-session-related operations include:

Service Reference:

Examples:

Calling the searchGameSessions operation

var params = {
  AliasId: 'STRING_VALUE',
  FilterExpression: 'STRING_VALUE',
  FleetId: 'STRING_VALUE',
  Limit: 0,
  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)

      Unique identifier for a fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

    • AliasId — (String)

      Unique identifier for an alias associated with the fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

    • 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, creationTimeMillis, playerSessionCount, maximumSessions, hasAvailablePlayerSessions.

      • Comparator -- Valid comparators are: =, <>, <, >, <=, >=.

      • Value -- Value to be searched for. Values can be numbers, boolean values (true/false) or strings. String values are case sensitive, 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, creationTimeMillis, playerSessionCount, maximumSessions, 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)

      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)

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

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

        Collection of objects containing game session properties for each session matching the request.

        • GameSessionId — (String)

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

        • Name — (String)

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

        • FleetId — (String)

          Unique identifier for a fleet the game session is running on.

        • CreationTime — (Date)

          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)

          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)

          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"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • IpAddress — (String)

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

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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)

          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)

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

      • NextToken — (String)

        Token that indicates where to resume retrieving results on the next call to this action. 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.

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 IDs and player data for each player you want to join to the new game session

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

If successful, a new game session placement is created.

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

Game-session-related operations include:

Service Reference:

Examples:

Calling the startGameSessionPlacement operation

var params = {
  GameSessionQueueName: 'STRING_VALUE', /* required */
  MaximumPlayerSessionCount: 0, /* 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: 0.0,
      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)

      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.

    • GameProperties — (Array<map>)

      Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

      • Keyrequired — (String)

        Game property identifier.

      • Valuerequired — (String)

        Game property value.

    • MaximumPlayerSessionCount — (Integer)

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

    • GameSessionName — (String)

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

    • PlayerLatencies — (Array<map>)

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

      • PlayerId — (String)

        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)

        Unique identifier for a player to associate with the player session.

      • PlayerData — (String)

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

    • GameSessionData — (String)

      Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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)

          Unique identifier for a game session placement.

        • GameSessionQueueName — (String)

          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.

          Possible values include:
          • "PENDING"
          • "FULFILLED"
          • "CANCELLED"
          • "TIMED_OUT"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • MaximumPlayerSessionCount — (Integer)

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

        • GameSessionName — (String)

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

        • GameSessionId — (String)

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

          Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

          • PlayerId — (String)

            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)

          IP address of the game session. To connect to a Amazon 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).

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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>)

          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)

            Unique identifier for a player that is associated with this player session.

          • PlayerSessionId — (String)

            Unique identifier for a player session.

        • GameSessionData — (String)

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

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

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

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

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

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

Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows:

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

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

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

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

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

Matchmaking-related operations include:

Service Reference:

Examples:

Calling the startMatchmaking operation

var params = {
  ConfigurationName: 'STRING_VALUE', /* required */
  Players: [ /* required */
    {
      LatencyInMs: {
        '<NonEmptyString>': 0,
        /* '<NonEmptyString>': ... */
      },
      PlayerAttributes: {
        '<NonZeroAndMaxString>': {
          N: 0.0,
          S: 'STRING_VALUE',
          SDM: {
            '<NonZeroAndMaxString>': 0.0,
            /* '<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)

      Unique identifier for a matchmaking ticket. 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.

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

        Unique identifier for a player

      • PlayerAttributes — (map<map>)

        Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. 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 occurances of the the repeated value after the first of a repeated value are ignored.

        • SDM — (map<Float>)

          For a map of up to 10 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>)

        Set of values, expressed in milliseconds, indicating 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 that are included in the object map. If not present (that is, null), FlexMatch ignores latency issues and may place the match in any region in the queue.

        Note: If this property contains an empty map, FlexMatch assumes that no regions are available to the player. In this scenario, the ticket is not matchable and always times out unless canceled.

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)

          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.

        • 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. Tickets with players who fail to accept a proposed match are placed in FAILED status; new matchmaking requests can be submitted for these players.

          • CANCELLED – The matchmaking request was canceled with a call to StopMatchmaking.

          • TIMED_OUT – The matchmaking request was not completed within the duration specified in the matchmaking configuration. Matchmaking requests that time out can be resubmitted.

          Possible values include:
          • "CANCELED"
          • "COMPLETE"
          • "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").

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

            Unique identifier for a player

          • PlayerAttributes — (map<map>)

            Collection of name:value pairs containing player information for use in matchmaking. Player attribute names need to match playerAttributes names in the rule set being used. 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 occurances of the the repeated value after the first of a repeated value are ignored.

            • SDM — (map<Float>)

              For a map of up to 10 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>)

            Set of values, expressed in milliseconds, indicating 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 that are included in the object map. If not present (that is, null), FlexMatch ignores latency issues and may place the match in any region in the queue.

            Note: If this property contains an empty map, FlexMatch assumes that no regions are available to the player. In this scenario, the ticket is not matchable and always times out unless canceled.
        • 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.

          • GameSessionArn — (String)

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

          • IpAddress — (String)

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

          • Port — (Integer)

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

          • MatchedPlayerSessions — (Array<map>)

            Collection of player session IDs, one for each player ID that was included in the original matchmaking request.

            • PlayerId — (String)

              Unique identifier for a player

            • PlayerSessionId — (String)

              Unique identifier for a player session

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.

Game-session-related operations include:

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)

      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)

          Unique identifier for a game session placement.

        • GameSessionQueueName — (String)

          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.

          Possible values include:
          • "PENDING"
          • "FULFILLED"
          • "CANCELLED"
          • "TIMED_OUT"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • MaximumPlayerSessionCount — (Integer)

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

        • GameSessionName — (String)

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

        • GameSessionId — (String)

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

          Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

          • PlayerId — (String)

            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)

          IP address of the game session. To connect to a Amazon 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).

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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>)

          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)

            Unique identifier for a player that is associated with this player session.

          • PlayerSessionId — (String)

            Unique identifier for a player session.

        • GameSessionData — (String)

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

Returns:

  • (AWS.Request)

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

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

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

Matchmaking-related operations include:

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)

      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.

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.

Alias-related operations include:

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)

      Unique identifier for a fleet alias. Specify the alias you want to update.

    • Name — (String)

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

    • Description — (String)

      Human-readable description of an alias.

    • RoutingStrategy — (map)

      Object that specifies the fleet and routing type to use for the alias.

      • Type — (String)

        Type of routing strategy.

        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)

        Unique identifier for a fleet that the alias points to.

      • Message — (String)

        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)

        Object that contains the updated alias configuration.

        • AliasId — (String)

          Unique identifier for an alias; alias IDs are unique within a region.

        • Name — (String)

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

        • AliasArn — (String)

          Unique identifier for an alias; alias ARNs are unique across all regions.

        • Description — (String)

          Human-readable description of an alias.

        • RoutingStrategy — (map)

          Alias configuration for the alias, including routing type and settings.

          • Type — (String)

            Type of routing strategy.

            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)

            Unique identifier for a fleet that the alias points to.

          • Message — (String)

            Message text to be used with a terminal routing strategy.

        • CreationTime — (Date)

          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)

          Time stamp indicating when 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 record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Build-related operations include:

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)

      Unique identifier for a build to update.

    • Name — (String)

      Descriptive label that is associated with a build. Build names do not need to be unique.

    • Version — (String)

      Version that is associated with this build. 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)

        Object that contains the updated build record.

        • BuildId — (String)

          Unique identifier for a build.

        • Name — (String)

          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 that is associated with this build. 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"
        • CreationTime — (Date)

          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 fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

Fleet-related operations include:

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: 0,
    PolicyPeriodInMinutes: 0
  }
};
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)

      Unique identifier for a fleet to update attribute metadata for.

    • Name — (String)

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

    • Description — (String)

      Human-readable description of a fleet.

    • NewGameSessionProtectionPolicy — (String)

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

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

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

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

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

      • NewGameSessionsPerCreator — (Integer)

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

      • PolicyPeriodInMinutes — (Integer)

        Time span used in evaluating the resource creation limit policy.

    • MetricGroups — (Array<String>)

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

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)

        Unique identifier for a 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. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the updateFleetCapacity operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  DesiredInstances: 0,
  MaxSize: 0,
  MinSize: 0
};
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)

      Unique identifier for a fleet to update capacity for.

    • DesiredInstances — (Integer)

      Number of EC2 instances you want this fleet to host.

    • MinSize — (Integer)

      Minimum value allowed for the fleet's instance count. Default if not set is 0.

    • MaxSize — (Integer)

      Maximum value allowed for the fleet's instance count. Default if not set is 1.

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)

        Unique identifier for a fleet that was updated.

Returns:

  • (AWS.Request)

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

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

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the updateFleetPortSettings operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  InboundPermissionAuthorizations: [
    {
      FromPort: 0, /* required */
      IpRange: 'STRING_VALUE', /* required */
      Protocol: TCP | UDP, /* required */
      ToPort: 0 /* required */
    },
    /* more items */
  ],
  InboundPermissionRevocations: [
    {
      FromPort: 0, /* required */
      IpRange: 'STRING_VALUE', /* required */
      Protocol: TCP | UDP, /* required */
      ToPort: 0 /* 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)

      Unique identifier for a fleet to update port settings for.

    • InboundPermissionAuthorizations — (Array<map>)

      Collection of port settings to be added to the fleet record.

      • FromPortrequired — (Integer)

        Starting value for a range of allowed port numbers.

      • ToPortrequired — (Integer)

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

      • IpRangerequired — (String)

        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)

        Network communication protocol used by the fleet.

        Possible values include:
        • "TCP"
        • "UDP"
    • InboundPermissionRevocations — (Array<map>)

      Collection of port settings to be removed from the fleet record.

      • FromPortrequired — (Integer)

        Starting value for a range of allowed port numbers.

      • ToPortrequired — (Integer)

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

      • IpRangerequired — (String)

        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)

        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)

        Unique identifier for a fleet that was updated.

Returns:

  • (AWS.Request)

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

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

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

Game-session-related operations include:

Service Reference:

Examples:

Calling the updateGameSession operation

var params = {
  GameSessionId: 'STRING_VALUE', /* required */
  MaximumPlayerSessionCount: 0,
  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)

      Unique identifier for the game session to update.

    • MaximumPlayerSessionCount — (Integer)

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

    • Name — (String)

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

    • PlayerSessionCreationPolicy — (String)

      Policy determining whether or not the game session accepts 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)

        Object that contains the updated game session metadata.

        • GameSessionId — (String)

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

        • Name — (String)

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

        • FleetId — (String)

          Unique identifier for a fleet the game session is running on.

        • CreationTime — (Date)

          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)

          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)

          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"
        • GameProperties — (Array<map>)

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • IpAddress — (String)

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

        • Port — (Integer)

          Port number for the game session. To connect to a Amazon 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)

          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)

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

Returns:

  • (AWS.Request)

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

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

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

Queue-related operations include:

Service Reference:

Examples:

Calling the updateGameSessionQueue operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Destinations: [
    {
      DestinationArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  PlayerLatencyPolicies: [
    {
      MaximumIndividualPlayerLatencyMilliseconds: 0,
      PolicyDurationSeconds: 0
    },
    /* more items */
  ],
  TimeoutInSeconds: 0
};
gamelift.updateGameSessionQueue(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)

      Descriptive label that is associated with game session queue. Queue names must be unique within each region.

    • TimeoutInSeconds — (Integer)

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

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

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

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

      • DestinationArn — (String)

        Amazon Resource Name (ARN) 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.

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)

        Object that describes the newly updated game session queue.

        • Name — (String)

          Descriptive label that is associated with game session queue. Queue names must be unique within each region.

        • GameSessionQueueArn — (String)

          Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

        • TimeoutInSeconds — (Integer)

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

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

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

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

          • DestinationArn — (String)

            Amazon Resource Name (ARN) 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.

Returns:

  • (AWS.Request)

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

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

Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.

Operations related to match configurations and rule sets include:

Service Reference:

Examples:

Calling the updateMatchmakingConfiguration operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AcceptanceRequired: true || false,
  AcceptanceTimeoutSeconds: 0,
  AdditionalPlayerCount: 0,
  CustomEventData: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  GameProperties: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  GameSessionData: 'STRING_VALUE',
  GameSessionQueueArns: [
    'STRING_VALUE',
    /* more items */
  ],
  NotificationTarget: 'STRING_VALUE',
  RequestTimeoutSeconds: 0,
  RuleSetName: 'STRING_VALUE'
};
gamelift.updateMatchmakingConfiguration(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)

      Unique identifier for a matchmaking configuration to update.

    • Description — (String)

      Descriptive label that is associated with matchmaking configuration.

    • GameSessionQueueArns — (Array<String>)

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

    • RequestTimeoutSeconds — (Integer)

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

    • AcceptanceTimeoutSeconds — (Integer)

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

    • AcceptanceRequired — (Boolean)

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

    • RuleSetName — (String)

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

    • NotificationTarget — (String)

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

    • AdditionalPlayerCount — (Integer)

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

    • CustomEventData — (String)

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

    • GameProperties — (Array<map>)

      Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

      • Keyrequired — (String)

        Game property identifier.

      • Valuerequired — (String)

        Game property value.

    • GameSessionData — (String)

      Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

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 updated matchmaking configuration.

        • Name — (String)

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

        • Description — (String)

          Descriptive label that is associated with matchmaking configuration.

        • GameSessionQueueArns — (Array<String>)

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

        • RequestTimeoutSeconds — (Integer)

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

        • AcceptanceTimeoutSeconds — (Integer)

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

        • AcceptanceRequired — (Boolean)

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

        • RuleSetName — (String)

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

        • NotificationTarget — (String)

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

        • AdditionalPlayerCount — (Integer)

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

        • CustomEventData — (String)

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

        • CreationTime — (Date)

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

          Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server 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.

          • Keyrequired — (String)

            Game property identifier.

          • Valuerequired — (String)

            Game property value.

        • GameSessionData — (String)

          Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server 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.

Returns:

  • (AWS.Request)

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

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

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

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

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

Fleet-related operations include:

Service Reference:

Examples:

Calling the updateRuntimeConfiguration operation

var params = {
  FleetId: 'STRING_VALUE', /* required */
  RuntimeConfiguration: { /* required */
    GameSessionActivationTimeoutSeconds: 0,
    MaxConcurrentGameSessionActivations: 0,
    ServerProcesses: [
      {
        ConcurrentExecutions: 0, /* required */
        LaunchPath: 'STRING_VALUE', /* required */
        Parameters: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
gamelift.updateRuntimeConfiguration(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)

      Unique identifier for a fleet to update run-time configuration for.

    • RuntimeConfiguration — (map)

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

      • ServerProcesses — (Array<map>)

        Collection of server process configurations that describe which server processes to run on each instance in a fleet.

        • LaunchPathrequired — (String)

          Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe".

        • Parameters — (String)

          Optional list of parameters to pass to the server executable on launch.

        • ConcurrentExecutionsrequired — (Integer)

          Number of server processes using this configuration to run concurrently on an instance.

      • MaxConcurrentGameSessionActivations — (Integer)

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

      • GameSessionActivationTimeoutSeconds — (Integer)

        Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.

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)

        The run-time configuration currently in force. If the update was successful, this object matches the one in the request.

        • ServerProcesses — (Array<map>)

          Collection of server process configurations that describe which server processes to run on each instance in a fleet.

          • LaunchPathrequired — (String)

            Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\latest\server.exe must have a launch path of "C:\game\MyGame\latest\server.exe". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of "/local/game/MyGame/latest/server.exe".

          • Parameters — (String)

            Optional list of parameters to pass to the server executable on launch.

          • ConcurrentExecutionsrequired — (Integer)

            Number of server processes using this configuration to run concurrently on an instance.

        • MaxConcurrentGameSessionActivations — (Integer)

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

        • GameSessionActivationTimeoutSeconds — (Integer)

          Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.

Returns:

  • (AWS.Request)

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

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

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

Operations related to match configurations and rule sets include:

Service Reference:

Examples:

Calling the validateMatchmakingRuleSet operation

var params = {
  RuleSetBody: 'STRING_VALUE' /* required */
};
gamelift.validateMatchmakingRuleSet(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: {})
    • RuleSetBody — (String)

      Collection of matchmaking rules to validate, formatted as a JSON string.

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:

      • Valid — (Boolean)

        Response indicating whether or not the rule set is valid.

Returns:

  • (AWS.Request)

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