NimbleStudio / Waiter / StreamingSessionStreamReady

StreamingSessionStreamReady#

class NimbleStudio.Waiter.StreamingSessionStreamReady#
waiter = client.get_waiter('streaming_session_stream_ready')
wait(**kwargs)#

Polls NimbleStudio.Client.get_streaming_session_stream() every 5 seconds until a successful state is reached. An error is returned after 30 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    sessionId='string',
    streamId='string',
    studioId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • sessionId (string) –

    [REQUIRED]

    The streaming session ID.

  • streamId (string) –

    [REQUIRED]

    The streaming session stream ID.

  • studioId (string) –

    [REQUIRED]

    The studio ID.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 5

    • MaxAttempts (integer) –

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

Returns:

None