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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::DescribeGameSessionsInput

Defined in:

gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias_id ⇒ String

  A unique identifier for the alias associated with the fleet to retrieve game sessions for.

• #fleet_id ⇒ String

  A unique identifier for the fleet to retrieve game sessions for.

• #game_session_id ⇒ String

  An identifier for the game session that is unique across all regions to retrieve.

• #limit ⇒ Integer

  The maximum number of results to return.

• #location ⇒ String

  A fleet location to get game sessions for.

• #next_token ⇒ String

  A token that indicates the start of the next sequential page of results.

• #status_filter ⇒ String

  Game session status to filter results on.

Instance Attribute Details

#alias_id ⇒ String

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)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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

#fleet_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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

#game_session_id ⇒ String

An identifier for the game session that is unique across all regions to retrieve. The value is always a full ARN in the following format: arn:aws:gamelift:<location>::gamesession/<fleet ID>/<ID string>.

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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

#location ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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

#next_token ⇒ String

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)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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

#status_filter ⇒ String

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)

# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4942

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