Class: Aws::GameLift::Types::DescribeGameSessionsInput

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

Overview

Note:

When making an API call, you may pass DescribeGameSessionsInput data as a hash:

{
  fleet_id: "FleetIdOrArn",
  game_session_id: "ArnStringModel",
  alias_id: "AliasIdOrArn",
  location: "LocationStringModel",
  status_filter: "NonZeroAndMaxString",
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Represents the input for a request operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alias_idString

A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.

Returns:

  • (String)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_idString

A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.

Returns:

  • (String)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#game_session_idString

A unique identifier for the game session to retrieve.

Returns:

  • (String)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#limitInteger

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

Returns:

  • (Integer)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#locationString

A fleet location to get game session details for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

Returns:

  • (String)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#status_filterString

Game session status to filter results on. You can filter on the following states: ACTIVE, TERMINATED, ACTIVATING, and TERMINATING. The last two are transitory and used for only very brief periods of time.

Returns:

  • (String)


3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3468

class DescribeGameSessionsInput < Struct.new(
  :fleet_id,
  :game_session_id,
  :alias_id,
  :location,
  :status_filter,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end