class Aws::GameLift::Types::DescribeGameSessionsInput
Represents the input for a request operation.
@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", }
@!attribute [rw] fleet_id
A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. @return [String]
@!attribute [rw] game_session_id
A unique identifier for the game session to retrieve. @return [String]
@!attribute [rw] alias_id
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. @return [String]
@!attribute [rw] location
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`. @return [String]
@!attribute [rw] status_filter
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. @return [String]
@!attribute [rw] limit
The maximum number of results to return. Use this parameter with `NextToken` to get results as a set of sequential pages. @return [Integer]
@!attribute [rw] next_token
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionsInput AWS API Documentation
Constants
- SENSITIVE