<a id="cli-aws-gamelift-create-game-session"></a>

# create-game-session

## Description

> **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](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html) , 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](https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html) to change the game session’s player session creation policy.

Amazon GameLift Servers retains logs for active game sessions for 14 days. To access the logs, call [GetGameSessionLogUrl](https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html) to download the log files.

> *Available in Amazon GameLift Servers Local.*

> **Learn more**

> [Start a game session](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession)

> [All APIs by task](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameSession)

## Synopsis

```
  create-game-session
[--fleet-id <value>]
[--alias-id <value>]
--maximum-player-session-count <value>
[--name <value>]
[--game-properties <value>]
[--creator-id <value>]
[--game-session-id <value>]
[--idempotency-token <value>]
[--game-session-data <value>]
[--location <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
```

## Options

`--fleet-id` (string)

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

> Constraints:

> * min: `1`
> * max: `512`
> * pattern: `^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$`

`--alias-id` (string)

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

> Constraints:

> * min: `1`
> * max: `512`
> * pattern: `^(alias-\S+|arn:.*:alias\/alias-\S+)$`

`--maximum-player-session-count` (integer) [required]

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

> Constraints:

> * min: `0`

`--name` (string)

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

> Constraints:

> * min: `1`
> * max: `1024`

`--game-properties` (list)

> 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](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-create) .

> #### NOTE
> * Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.
> * If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.

> Constraints:

> * max: `16`

> (structure)

> > This key-value pair can store custom data about a game session. For example, you might use a `GameProperty` to track a game session’s map, level of difficulty, or remaining time. The difficulty level could be specified like this: `{"Key": "difficulty", "Value":"Novice"}` .

> > You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can’t delete game properties from a game session.

> > For examples of working with game properties, see [Create a game session with properties](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties) .

> > Key -> (string) [required]

> > > The game property identifier.

> > > #### NOTE
> > > * Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.
> > > * If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.

> > > Constraints:

> > > * max: `32`

> > Value -> (string) [required]

> > > The game property value.

> > > Constraints:

> > > * max: `96`

Shorthand Syntax:

```
Key=string,Value=string ...
```

JSON Syntax:

```json
[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]
```

`--creator-id` (string)

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

> Constraints:

> * min: `1`
> * max: `1024`

`--game-session-id` (string)

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

> Constraints:

> * min: `1`
> * max: `48`
> * pattern: `^[a-zA-Z0-9-]+$`

`--idempotency-token` (string)

> Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original `GameSession` object, with an updated status. Maximum token length is 48 characters. If provided, this string is included in the new game session’s ID. The value is always a full ARN in the following format: For Home Region game session - `arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string>` . For Remote Location game session - `arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string>` . 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.

> Constraints:

> * min: `1`
> * max: `48`
> * pattern: `^[a-zA-Z0-9-]+$`

`--game-session-data` (string)

> 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](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) .

> Constraints:

> * min: `1`
> * max: `262144`

`--location` (string)

> A fleet’s remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet’s home Region. Specify a remote location with an 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.

> Constraints:

> * min: `1`
> * max: `64`
> * pattern: `^[A-Za-z0-9\-]+$`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

## Output

GameSession -> (structure)

> Object that describes the newly created game session record.

> GameSessionId -> (string)

> > An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - `arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<ID string>` . For Remote Location game session - `arn:aws:gamelift:<home_region>::gamesession/<fleet ID>/<location>/<ID string>` .

> > Constraints:

> > * min: `1`
> > * max: `1024`

> Name -> (string)

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

> > Constraints:

> > * min: `1`
> > * max: `1024`

> FleetId -> (string)

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

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `^[a-z]*fleet-[a-zA-Z0-9\-]+$`

> FleetArn -> (string)

> > The Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html) ) associated with the GameLift fleet that this game session is running on.

> > Constraints:

> > * min: `1`
> > * max: `512`
> > * pattern: `^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$`

> CreationTime -> (timestamp)

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

> TerminationTime -> (timestamp)

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

> CurrentPlayerSessionCount -> (integer)

> > Number of players currently in the game session.

> > Constraints:

> > * min: `0`

> MaximumPlayerSessionCount -> (integer)

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

> > Constraints:

> > * min: `0`

> Status -> (string)

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

> > Possible values:

> > * `ACTIVE`
> > * `ACTIVATING`
> > * `TERMINATED`
> > * `TERMINATING`
> > * `ERROR`

> StatusReason -> (string)

> > Provides additional information about game session status.

> > * `INTERRUPTED` – The game session was hosted on an EC2 Spot instance that was reclaimed, causing the active game session to be stopped.
> > * `TRIGGERED_ON_PROCESS_TERMINATE` – The game session was stopped by calling `TerminateGameSession` with the termination mode `TRIGGER_ON_PROCESS_TERMINATE` .
> > * `FORCE_TERMINATED` – The game session was stopped by calling `TerminateGameSession` with the termination mode `FORCE_TERMINATE` .

> > Possible values:

> > * `INTERRUPTED`
> > * `TRIGGERED_ON_PROCESS_TERMINATE`
> > * `FORCE_TERMINATED`

> GameProperties -> (list)

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

> > #### NOTE
> > * Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.
> > * If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.

> > Constraints:

> > * max: `16`

> > (structure)

> > > This key-value pair can store custom data about a game session. For example, you might use a `GameProperty` to track a game session’s map, level of difficulty, or remaining time. The difficulty level could be specified like this: `{"Key": "difficulty", "Value":"Novice"}` .

> > > You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can’t delete game properties from a game session.

> > > For examples of working with game properties, see [Create a game session with properties](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties) .

> > > Key -> (string) [required]

> > > > The game property identifier.

> > > > #### NOTE
> > > > * Avoid using periods (“.”) in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.
> > > > * If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.

> > > > Constraints:

> > > > * max: `32`

> > > Value -> (string) [required]

> > > > The game property value.

> > > > Constraints:

> > > > * max: `96`

> IpAddress -> (string)

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

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `^[0-9A-Fa-f\:\.]+$`

> DnsName -> (string)

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

> > * TLS-enabled fleets: `<unique identifier>.<region identifier>.amazongamelift.com` .
> > * Non-TLS-enabled fleets: `ec2-<unique identifier>.compute.amazonaws.com` . (See [Amazon EC2 Instance IP Addressing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses) .)

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

> Port -> (integer)

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

> > Constraints:

> > * min: `1`
> > * max: `60000`

> PlayerSessionCreationPolicy -> (string)

> > Indicates whether the game session is accepting new players.

> > Possible values:

> > * `ACCEPT_ALL`
> > * `DENY_ALL`

> CreatorId -> (string)

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

> > Constraints:

> > * min: `1`
> > * max: `1024`

> GameSessionData -> (string)

> > 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](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession) .

> > Constraints:

> > * min: `1`
> > * max: `262144`

> MatchmakerData -> (string)

> > Information about the matchmaking process that resulted in the game session, if matchmaking was used. Data is in JSON syntax, formatted as a string. Information includes the matchmaker ID as well as player attributes and team assignments. For more details on matchmaker data, see [Match Data](https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data) . Matchmaker data is updated whenever new players are added during a successful backfill (see [StartMatchBackfill](https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html) ).

> > Constraints:

> > * min: `1`
> > * max: `390000`

> Location -> (string)

> > The fleet location where the game session is running. This value might specify the fleet’s home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as `us-west-2` .

> > Constraints:

> > * min: `1`
> > * max: `64`
> > * pattern: `^[A-Za-z0-9\-]+$`

> ComputeName -> (string)

> > A descriptive label for the compute resource. The compute resource that is hosting the game session. For EC2 fleets, this is the EC2 instance ID. For Container fleets, each game server container group on a fleet instance is assigned a compute name. For Anywhere fleets, this is the custom compute name.

> > Constraints:

> > * min: `1`
> > * max: `128`
> > * pattern: `^[a-zA-Z0-9\-]+(\/[a-zA-Z0-9\-]+)?$`

> PlayerGatewayStatus -> (string)

> > Indicates whether player gateway is available for use for this game session. Note, even if a fleet has PlayerGatewayMode configured as `ENABLED` , player gateway might not be available in a specific location. For more information about locations where player gateway is supported, see [Amazon GameLift Servers service locations](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/gamelift-regions.html) .

> > Possible values include:

> > * `ENABLED` – Player gateway is available for routing player connections for this game session.
> > * `DISABLED` – Player gateway is not available for this game session.

> > Possible values:

> > * `DISABLED`
> > * `ENABLED`