:doc:`Kinesis <../../kinesis>` / Waiter / StreamNotExists

***************
StreamNotExists
***************



.. py:class:: Kinesis.Waiter.StreamNotExists

  ::

    
    waiter = client.get_waiter('stream_not_exists')

  
  

  .. py:method:: wait(**kwargs)

    Polls :py:meth:`Kinesis.Client.describe_stream` every 10 seconds until a successful state is reached. An error is raised after 18 failed checks.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStream>`_    


    **Request Syntax**
    ::

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

      The name of the stream to describe.

      

    
    :type Limit: integer
    :param Limit: 

      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.

      

    
    :type ExclusiveStartShardId: string
    :param ExclusiveStartShardId: 

      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.

      

    
    :type StreamARN: string
    :param StreamARN: 

      The ARN of the stream.

      

    
    :type StreamId: string
    :param StreamId: 

      Not Implemented. Reserved for future use.

      

    
    :type WaiterConfig: dict
    :param WaiterConfig: 

      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