Skip to content

/AWS1/IF_GML=>CREATEGAMESESSION()

About CreateGameSession

This API works with the following fleet types: EC2, Anywhere, Container

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

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

You can use this operation in the following ways:

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

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

  • To create a game session on an instance in an Anywhere fleet, specify the fleet's custom location.

If successful, Amazon GameLift Servers initiates a workflow to start a new game session and returns a GameSession object containing the game session configuration and status. When the game session status is ACTIVE, it is updated with connection information and you can create player sessions for the game session. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Amazon GameLift Servers retains logs for active for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Servers Local.

Learn more

Start a game session

All APIs by task

Method Signature

METHODS /AWS1/IF_GML~CREATEGAMESESSION
  IMPORTING
    !IV_FLEETID TYPE /AWS1/GMLFLEETIDORARN OPTIONAL
    !IV_ALIASID TYPE /AWS1/GMLALIASIDORARN OPTIONAL
    !IV_MAXIMUMPLAYERSESSIONCOUNT TYPE /AWS1/GMLWHOLENUMBER OPTIONAL
    !IV_NAME TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
    !IT_GAMEPROPERTIES TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST OPTIONAL
    !IV_CREATORID TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
    !IV_GAMESESSIONID TYPE /AWS1/GMLIDSTRINGMODEL OPTIONAL
    !IV_IDEMPOTENCYTOKEN TYPE /AWS1/GMLIDSTRINGMODEL OPTIONAL
    !IV_GAMESESSIONDATA TYPE /AWS1/GMLLARGEGAMESESSIONDATA OPTIONAL
    !IV_LOCATION TYPE /AWS1/GMLLOCATIONSTRINGMODEL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmlcreategamesessout
  RAISING
    /AWS1/CX_GMLCONFLICTEXCEPTION
    /AWS1/CX_GMLFLEETCAPEXCDEX
    /AWS1/CX_GMLIDEMPOTENTPRMMIS00
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVFLEETSTATUSEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLLIMITEXCEEDEDEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLTERMINALROUTINGS00
    /AWS1/CX_GMLUNAUTHORIZEDEX
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_maximumplayersessioncount TYPE /AWS1/GMLWHOLENUMBER /AWS1/GMLWHOLENUMBER

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

Optional arguments:

iv_fleetid TYPE /AWS1/GMLFLEETIDORARN /AWS1/GMLFLEETIDORARN

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

iv_aliasid TYPE /AWS1/GMLALIASIDORARN /AWS1/GMLALIASIDORARN

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

iv_name TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

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

it_gameproperties TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST TT_GAMEPROPERTYLIST

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. For an example, see Create a game session with custom properties.

iv_creatorid TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

A unique identifier for a player or entity creating the game session.

If you add a resource creation limit policy to a fleet, the CreateGameSession operation requires a CreatorId. Amazon GameLift Servers limits the number of game session creation requests with the same CreatorId in a specified time period.

If you your fleet doesn't have a resource creation limit policy and you provide a CreatorId in your CreateGameSession requests, Amazon GameLift Servers limits requests to one request per CreatorId per second.

To not limit CreateGameSession requests with the same CreatorId, don't provide a CreatorId in your CreateGameSession request.

iv_gamesessionid TYPE /AWS1/GMLIDSTRINGMODEL /AWS1/GMLIDSTRINGMODEL

This parameter is deprecated. 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.

iv_idempotencytoken TYPE /AWS1/GMLIDSTRINGMODEL /AWS1/GMLIDSTRINGMODEL

Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. A game session ARN has the following format: arn:aws:gamelift:::gamesession//. 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.

iv_gamesessiondata TYPE /AWS1/GMLLARGEGAMESESSIONDATA /AWS1/GMLLARGEGAMESESSIONDATA

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see Start a game session.

iv_location TYPE /AWS1/GMLLOCATIONSTRINGMODEL /AWS1/GMLLOCATIONSTRINGMODEL

A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as us-west-2. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom location.

RETURNING

oo_output TYPE REF TO /aws1/cl_gmlcreategamesessout /AWS1/CL_GMLCREATEGAMESESSOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->creategamesession(
  it_gameproperties = VALUE /aws1/cl_gmlgameproperty=>tt_gamepropertylist(
    (
      new /aws1/cl_gmlgameproperty(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_aliasid = |string|
  iv_creatorid = |string|
  iv_fleetid = |string|
  iv_gamesessiondata = |string|
  iv_gamesessionid = |string|
  iv_idempotencytoken = |string|
  iv_location = |string|
  iv_maximumplayersessioncount = 123
  iv_name = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_gamesession = lo_result->get_gamesession( ).
  IF lo_gamesession IS NOT INITIAL.
    lv_nonzeroandmaxstring = lo_gamesession->get_gamesessionid( ).
    lv_nonzeroandmaxstring = lo_gamesession->get_name( ).
    lv_fleetid = lo_gamesession->get_fleetid( ).
    lv_fleetarn = lo_gamesession->get_fleetarn( ).
    lv_timestamp = lo_gamesession->get_creationtime( ).
    lv_timestamp = lo_gamesession->get_terminationtime( ).
    lv_wholenumber = lo_gamesession->get_currentplayersesscount( ).
    lv_wholenumber = lo_gamesession->get_maxplayersessioncount( ).
    lv_gamesessionstatus = lo_gamesession->get_status( ).
    lv_gamesessionstatusreason = lo_gamesession->get_statusreason( ).
    LOOP AT lo_gamesession->get_gameproperties( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_gamepropertykey = lo_row_1->get_key( ).
        lv_gamepropertyvalue = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_ipaddress = lo_gamesession->get_ipaddress( ).
    lv_dnsname = lo_gamesession->get_dnsname( ).
    lv_portnumber = lo_gamesession->get_port( ).
    lv_playersessioncreationpo = lo_gamesession->get_playersesscreationpolicy( ).
    lv_nonzeroandmaxstring = lo_gamesession->get_creatorid( ).
    lv_largegamesessiondata = lo_gamesession->get_gamesessiondata( ).
    lv_matchmakerdata = lo_gamesession->get_matchmakerdata( ).
    lv_locationstringmodel = lo_gamesession->get_location( ).
  ENDIF.
ENDIF.