start-game-session-placement

Description

Makes a request to start a new game session using a game session queue. When processing a placement request, Amazon GameLift looks for the best possible available resource to host the game session, based on how the queue is configured to prioritize factors such as resource cost, latency, and location. After selecting an available resource, Amazon GameLift prompts the resource to start a game session. A placement request can include a list of players to create a set of player sessions. The request can also include information to pass to the new game session, such as to specify a game map or other options.

Use this operation to make the following types of requests.

• Request a placement using the queue’s default prioritization process (see the default prioritization described in PriorityConfiguration ). Include these required parameters:
  • GameSessionQueueName
  • MaximumPlayerSessionCount
  • PlacementID
• Request a placement and prioritize based on latency. Include these parameters:
  • Required parameters GameSessionQueueName , MaximumPlayerSessionCount , PlacementID .
  • PlayerLatencies . Include a set of latency values for destinations in the queue. When a request includes latency data, Amazon GameLift automatically reorder the queue’s locations priority list based on lowest available latency values. If a request includes latency data for multiple players, Amazon GameLift calculates each location’s average latency for all players and reorders to find the lowest latency across all players.
  • Don’t include PriorityConfigurationOverride .
  • Prioritize based on a custom list of locations. If you’re using a queue that’s configured to prioritize location first (see PriorityConfiguration for game session queues), you can optionally use the PriorityConfigurationOverride parameter to substitute a different location priority list for this placement request. Amazon GameLift searches each location on the priority override list to find an available hosting resource for the new game session. Specify a fallback strategy to use in the event that Amazon GameLift fails to place the game session in any of the locations on the override list.
• Request a placement and prioritized based on a custom list of locations.
• You can request new player sessions for a group of players. Include the DesiredPlayerSessions parameter and include at minimum a unique player ID for each. You can also include player-specific data to pass to the new game session.

If successful, this operation generates a new game session placement request and adds it to the game session queue for processing. You can track the status of individual placement requests by calling DescribeGameSessionPlacement or by monitoring queue notifications. When the request status is FULFILLED , a new game session has started and the placement request is updated with connection information for the game session (IP address and port). If the request included player session data, Amazon GameLift creates a player session for each player ID in the request.

The request results in a InvalidRequestException in the following situations:

• If the request includes both PlayerLatencies and PriorityConfigurationOverride parameters.
• If the request includes the PriorityConfigurationOverride parameter and specifies a queue that doesn’t prioritize locations.

Amazon GameLift continues to retry each placement request until it reaches the queue’s timeout setting. If a request times out, you can resubmit the request to the same queue or try a different queue.

See also: AWS API Documentation

Synopsis

  start-game-session-placement
--placement-id <value>
--game-session-queue-name <value>
[--game-properties <value>]
--maximum-player-session-count <value>
[--game-session-name <value>]
[--player-latencies <value>]
[--desired-player-sessions <value>]
[--game-session-data <value>]
[--priority-configuration-override <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]

Options

--placement-id (string)

--game-session-queue-name (string)

--game-properties (list)

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

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

--maximum-player-session-count (integer)

--game-session-name (string)

--player-latencies (list)

Shorthand Syntax:

PlayerId=string,RegionIdentifier=string,LatencyInMilliseconds=float ...

JSON Syntax:

[
  {
    "PlayerId": "string",
    "RegionIdentifier": "string",
    "LatencyInMilliseconds": float
  }
  ...
]

--desired-player-sessions (list)

Shorthand Syntax:

PlayerId=string,PlayerData=string ...

JSON Syntax:

[
  {
    "PlayerId": "string",
    "PlayerData": "string"
  }
  ...
]

--game-session-data (string)

--priority-configuration-override (structure)

Shorthand Syntax:

PlacementFallbackStrategy=string,LocationOrder=string,string

JSON Syntax:

{
  "PlacementFallbackStrategy": "DEFAULT_AFTER_SINGLE_PASS"|"NONE",
  "LocationOrder": ["string", ...]
}

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

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

Output

GameSessionPlacement -> (structure)