:doc:`GameLiftStreams <../../gameliftstreams>` / Waiter / StreamSessionActive

*******************
StreamSessionActive
*******************



.. py:class:: GameLiftStreams.Waiter.StreamSessionActive

  ::

    
    waiter = client.get_waiter('stream_session_active')

  
  

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

    Polls :py:meth:`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 <https://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetStreamSession>`_    


    **Request Syntax**
    ::

      waiter.wait(
          Identifier='string',
          StreamSessionIdentifier='string',
          WaiterConfig={
              'Delay': 123,
              'MaxAttempts': 123
          }
      )
      
    :type Identifier: string
    :param Identifier: **[REQUIRED]** 

      The stream group that runs this stream session.

       

      This value is an `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`__ 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``.

      

    
    :type StreamSessionIdentifier: string
    :param StreamSessionIdentifier: **[REQUIRED]** 

      An `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`__ or ID that uniquely identifies the stream session resource. Example ARN: ``arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567``. Example ID: ``ABC123def4567``.

      

    
    :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: 2

        

      
      - **MaxAttempts** *(integer) --* 

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

        

      
    
    
    :returns: None