create_streaming_session_stream

create_streaming_session_stream(**kwargs)

Creates a streaming session stream for a streaming session.

After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the READY state.

See also: AWS API Documentation

Request Syntax

response = client.create_streaming_session_stream(
    clientToken='string',
    expirationInSeconds=123,
    sessionId='string',
    studioId='string'
)

Parameters

• clientToken (string) --

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

  This field is autopopulated if not provided.

• expirationInSeconds (integer) -- The expiration time in seconds.
• sessionId (string) --

  [REQUIRED]

  The streaming session ID.

• studioId (string) --

  [REQUIRED]

  The studio ID.

Return type

dict

Returns

Response Syntax

{
    'stream': {
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'expiresAt': datetime(2015, 1, 1),
        'ownedBy': 'string',
        'state': 'READY'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAM_CREATE_IN_PROGRESS'|'STREAM_READY'|'STREAM_DELETE_IN_PROGRESS'|'STREAM_DELETED'|'INTERNAL_ERROR'|'NETWORK_CONNECTION_ERROR',
        'streamId': 'string',
        'url': 'string'
    }
}

Response Structure

• (dict) --

  • stream (dict) --

    The stream.

    • createdAt (datetime) --

      The ISO timestamp in seconds for when the resource was created.

    • createdBy (string) --

      The user ID of the user that created the streaming session stream.

    • expiresAt (datetime) --

      The ISO timestamp in seconds for when the resource expires.

    • ownedBy (string) --

      The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

    • state (string) --

      The current state.

    • statusCode (string) --

      The streaming session stream status code.

    • streamId (string) --

      The stream ID.

    • url (string) --

      The URL to connect to this stream using the DCV client.

Exceptions

• NimbleStudio.Client.exceptions.ResourceNotFoundException
• NimbleStudio.Client.exceptions.ConflictException
• NimbleStudio.Client.exceptions.ThrottlingException
• NimbleStudio.Client.exceptions.ValidationException
• NimbleStudio.Client.exceptions.AccessDeniedException
• NimbleStudio.Client.exceptions.InternalServerErrorException
• NimbleStudio.Client.exceptions.ServiceQuotaExceededException