GameLiftStreams / Waiter / StreamGroupActive

StreamGroupActive¶

class GameLiftStreams.Waiter.StreamGroupActive¶

waiter = client.get_waiter('stream_group_active')

wait(**kwargs)¶

Polls GameLiftStreams.Client.get_stream_group() every 30 seconds until a successful state is reached. An error is raised after 120 failed checks.

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

Parameters:

Identifier (string) –
[REQUIRED]

An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-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: 30
- MaxAttempts (integer) –
  
  The maximum number of attempts to be made. Default: 120

Returns:

None