Kinesis / Waiter / ChannelActive

ChannelActive¶

class Kinesis.Waiter.ChannelActive¶

waiter = client.get_waiter('channel_active')

wait(**kwargs)¶

Polls Kinesis.Client.describe_channel() every 10 seconds until a successful state is reached. An error is raised after 18 failed checks.

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

Parameters:

ChannelARN (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the channel to describe.
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  
  The amount of time in seconds to wait between attempts. Default: 10
- MaxAttempts (integer) –
  
  The maximum number of attempts to be made. Default: 18

Returns:

None