Kinesis / Waiter / StreamExists

StreamExists#

class Kinesis.Waiter.StreamExists#
waiter = client.get_waiter('stream_exists')
wait(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

waiter.wait(
    StreamName='string',
    Limit=123,
    ExclusiveStartShardId='string',
    StreamARN='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • StreamName (string) – The name of the stream to describe.

  • Limit (integer) – The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

  • ExclusiveStartShardId (string) –

    The shard ID of the shard to start with.

    Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId .

    If you don’t specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.

  • StreamARN (string) – The ARN of the stream.

  • 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