GameLiftStreams / Waiter / StreamSessionActive

StreamSessionActive#

class GameLiftStreams.Waiter.StreamSessionActive#
waiter = client.get_waiter('stream_session_active')
wait(**kwargs)#

Polls GameLiftStreams.Client.get_stream_session() every 2 seconds until a successful state is reached. An error is raised after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    Identifier='string',
    StreamSessionIdentifier='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    The stream group that runs this stream session.

    This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Format example: ARN- arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4 or ID- sg-1AB2C3De4.

  • StreamSessionIdentifier (string) –

    [REQUIRED]

    An Amazon Resource Name (ARN) that uniquely identifies the stream session resource. Format example: 1AB2C3De4.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 2

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 60

Returns:

None