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
- Struct
- Aws::GameLift::Types::DescribeGameSessionDetailsInput
- Defined in:
- (unknown)
Overview
When passing DescribeGameSessionDetailsInput as input to an Aws::Client method, you can use a vanilla Hash:
{
fleet_id: "FleetIdOrArn",
game_session_id: "ArnStringModel",
alias_id: "AliasIdOrArn",
status_filter: "NonZeroAndMaxString",
limit: 1,
next_token: "NonZeroAndMaxString",
}
Represents the input for a request operation.
Instance Attribute Summary collapse
-
#alias_id ⇒ String
A unique identifier for an alias associated with the fleet to retrieve all game sessions for.
-
#fleet_id ⇒ String
A unique identifier for a fleet to retrieve all game sessions active on the fleet.
-
#game_session_id ⇒ String
A unique identifier for the game session to retrieve.
-
#limit ⇒ Integer
The maximum number of results to return.
-
#next_token ⇒ String
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 an alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
#fleet_id ⇒ String
A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
#game_session_id ⇒ String
A unique identifier for the game session to retrieve.
#limit ⇒ Integer
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
#next_token ⇒ String
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.
#status_filter ⇒ String
Game session status to filter results on. Possible game session statuses
include ACTIVE
, TERMINATED
, ACTIVATING
and TERMINATING
(the last
two are transitory).