You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GameLift::Types::GameSessionPlacement

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

  • StartGameSessionPlacement

  • DescribeGameSessionPlacement

  • StopGameSessionPlacement

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

Time stamp indicating when this request was completed, canceled, or timed out.

Returns:

  • (Time)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_propertiesArray<Types::GameProperty>

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

Returns:



3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_session_arnString

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.

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_session_dataString

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:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_session_idString

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_session_nameString

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

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_session_queue_nameString

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

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#game_session_regionString

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

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#ip_addressString

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

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#maximum_player_session_countInteger

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

Returns:

  • (Integer)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#placed_player_sessionsArray<Types::PlacedPlayerSession>

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.

Returns:



3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#placement_idString

Unique identifier for a game session placement.

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#player_latenciesArray<Types::PlayerLatency>

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

Returns:



3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#portInteger

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

Returns:

  • (Integer)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#start_timeTime

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

Returns:

  • (Time)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end

#statusString

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.

Returns:

  • (String)


3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3282

class GameSessionPlacement < Struct.new(
  :placement_id,
  :game_session_queue_name,
  :status,
  :game_properties,
  :maximum_player_session_count,
  :game_session_name,
  :game_session_id,
  :game_session_arn,
  :game_session_region,
  :player_latencies,
  :start_time,
  :end_time,
  :ip_address,
  :port,
  :placed_player_sessions,
  :game_session_data)
  include Aws::Structure
end