Puppet Task: gamelift_aws_describe_player_sessions

Defined in:: tasks/gamelift_aws_describe_player_sessions.json,
tasks/gamelift_aws_describe_player_sessions.rb

Overview

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player. To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request. Available in Amazon GameLift Local. CreatePlayerSession CreatePlayerSessions DescribePlayerSessions Game session placements StartGameSessionPlacement DescribeGameSessionPlacement StopGameSessionPlacement

Supports noop? false

Parameters

game_session_id (Optional[String[1]]) —
limit (Optional[String[1]]) —
next_token (Optional[String[1]]) —
player_id (Optional[String[1]]) —
player_session_id (Optional[String[1]]) —
player_session_status_filter (Optional[String[1]]) —