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

Class: Aws::GameLift::Types::DescribeGameSessionDetailsInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeGameSessionDetailsInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  fleet_id: "FleetId",
  game_session_id: "ArnStringModel",
  alias_id: "AliasId",
  status_filter: "NonZeroAndMaxString",
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#alias_idString

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

Returns:

  • (String)

    Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

#fleet_idString

Unique identifier for a fleet to retrieve all game sessions active on the fleet.

Returns:

  • (String)

    Unique identifier for a fleet to retrieve all game sessions active on the fleet.

#game_session_idString

Unique identifier for the game session to retrieve.

Returns:

  • (String)

    Unique identifier for the game session to retrieve.

#limitInteger

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

Returns:

  • (Integer)

    Maximum number of results to return.

#next_tokenString

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

Returns:

  • (String)

    Token that indicates the start of the next sequential page of results.

#status_filterString

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

Returns:

  • (String)

    Game session status to filter results on.