AmazonNimbleStudio

2021/08/11 - AmazonNimbleStudio - 6 updated api methods

Changes  Add new attribute 'ownedBy' in Streaming Session APIs. 'ownedBy' represents the AWS SSO Identity Store User ID of the owner of the Streaming Session resource.

CreateStreamingSession (updated) Link ¶
Changes (request, response)
Request 
{'ownedBy': 'string'}
Response 
{'session': {'ownedBy': 'string'}}

Creates a streaming session in a studio.

After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.

See also: AWS API Documentation

Request Syntax

client.create_streaming_session(
    clientToken='string',
    ec2InstanceType='g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
    launchProfileId='string',
    ownedBy='string',
    streamingImageId='string',
    studioId='string',
    tags={
        'string': 'string'
    }
)
type clientToken:

string

param clientToken:

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

This field is autopopulated if not provided.

type ec2InstanceType:

string

param ec2InstanceType:

The EC2 Instance type used for the streaming session.

type launchProfileId:

string

param launchProfileId:

The launch profile ID.

type ownedBy:

string

param ownedBy:

The user ID of the user that owns the streaming session.

type streamingImageId:

string

param streamingImageId:

The ID of the streaming image.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

type tags:

dict

param tags:

A collection of labels, in the form of key:value pairs, that apply to this resource.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'session': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'ec2InstanceType': 'string',
        'launchProfileId': 'string',
        'ownedBy': 'string',
        'sessionId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_SESSION_READY'|'STREAMING_SESSION_DELETED'|'STREAMING_SESSION_CREATE_IN_PROGRESS'|'STREAMING_SESSION_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'INSUFFICIENT_CAPACITY'|'ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR'|'NETWORK_CONNECTION_ERROR'|'INITIALIZATION_SCRIPT_ERROR'|'DECRYPT_STREAMING_IMAGE_ERROR'|'NETWORK_INTERFACE_ERROR',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • session (dict) --

      The session.

      • arn (string) --

        The ARN of the resource.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was created.

      • createdBy (string) --

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

      • ec2InstanceType (string) --

        The EC2 Instance type used for the streaming session.

      • launchProfileId (string) --

        The ID of the launch profile used to control access from the streaming session.

      • ownedBy (string) --

        The user ID of the user that owns the streaming session.

      • sessionId (string) --

        The session ID.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

        A collection of labels, in the form of key:value pairs, that apply to this resource.

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

CreateStreamingSessionStream (updated) Link ¶
Changes (response) 
{'stream': {'ownedBy': 'string'}}

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 state READY.

See also: AWS API Documentation

Request Syntax

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

string

param clientToken:

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

This field is autopopulated if not provided.

type expirationInSeconds:

integer

param expirationInSeconds:

The expiration time in seconds.

type sessionId:

string

param sessionId:

[REQUIRED]

The session ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

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) --

    Success

    • stream (dict) --

      The stream.

      • createdAt (datetime) --

        The Unix epoch 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 Unix epoch timestamp in seconds for when the resource expires.

      • ownedBy (string) --

        The user ID of the user that owns the streaming session.

      • 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.

DeleteStreamingSession (updated) Link ¶
Changes (response) 
{'session': {'ownedBy': 'string'}}

Deletes streaming session resource.

After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.

A streaming session will count against your streaming session quota until it is marked DELETED.

See also: AWS API Documentation

Request Syntax

client.delete_streaming_session(
    clientToken='string',
    sessionId='string',
    studioId='string'
)
type clientToken:

string

param clientToken:

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

This field is autopopulated if not provided.

type sessionId:

string

param sessionId:

[REQUIRED]

The session ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'session': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'ec2InstanceType': 'string',
        'launchProfileId': 'string',
        'ownedBy': 'string',
        'sessionId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_SESSION_READY'|'STREAMING_SESSION_DELETED'|'STREAMING_SESSION_CREATE_IN_PROGRESS'|'STREAMING_SESSION_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'INSUFFICIENT_CAPACITY'|'ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR'|'NETWORK_CONNECTION_ERROR'|'INITIALIZATION_SCRIPT_ERROR'|'DECRYPT_STREAMING_IMAGE_ERROR'|'NETWORK_INTERFACE_ERROR',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • session (dict) --

      The session.

      • arn (string) --

        The ARN of the resource.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was created.

      • createdBy (string) --

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

      • ec2InstanceType (string) --

        The EC2 Instance type used for the streaming session.

      • launchProfileId (string) --

        The ID of the launch profile used to control access from the streaming session.

      • ownedBy (string) --

        The user ID of the user that owns the streaming session.

      • sessionId (string) --

        The session ID.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

        A collection of labels, in the form of key:value pairs, that apply to this resource.

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

GetStreamingSession (updated) Link ¶
Changes (response) 
{'session': {'ownedBy': 'string'}}

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

See also: AWS API Documentation

Request Syntax

client.get_streaming_session(
    sessionId='string',
    studioId='string'
)
type sessionId:

string

param sessionId:

[REQUIRED]

The session ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'session': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'ec2InstanceType': 'string',
        'launchProfileId': 'string',
        'ownedBy': 'string',
        'sessionId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_SESSION_READY'|'STREAMING_SESSION_DELETED'|'STREAMING_SESSION_CREATE_IN_PROGRESS'|'STREAMING_SESSION_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'INSUFFICIENT_CAPACITY'|'ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR'|'NETWORK_CONNECTION_ERROR'|'INITIALIZATION_SCRIPT_ERROR'|'DECRYPT_STREAMING_IMAGE_ERROR'|'NETWORK_INTERFACE_ERROR',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

  • (dict) --

    Success

    • session (dict) --

      The session.

      • arn (string) --

        The ARN of the resource.

      • createdAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was created.

      • createdBy (string) --

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

      • ec2InstanceType (string) --

        The EC2 Instance type used for the streaming session.

      • launchProfileId (string) --

        The ID of the launch profile used to control access from the streaming session.

      • ownedBy (string) --

        The user ID of the user that owns the streaming session.

      • sessionId (string) --

        The session ID.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

        A collection of labels, in the form of key:value pairs, that apply to this resource.

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

GetStreamingSessionStream (updated) Link ¶
Changes (response) 
{'stream': {'ownedBy': 'string'}}

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.

See also: AWS API Documentation

Request Syntax

client.get_streaming_session_stream(
    sessionId='string',
    streamId='string',
    studioId='string'
)
type sessionId:

string

param sessionId:

[REQUIRED]

The session ID.

type streamId:

string

param streamId:

[REQUIRED]

The stream ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

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) --

    Success

    • stream (dict) --

      The stream.

      • createdAt (datetime) --

        The Unix epoch 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 Unix epoch timestamp in seconds for when the resource expires.

      • ownedBy (string) --

        The user ID of the user that owns the streaming session.

      • 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.

ListStreamingSessions (updated) Link ¶
Changes (request, response)
Request 
{'ownedBy': 'string'}
Response 
{'sessions': {'ownedBy': 'string'}}

Lists the streaming image resources in a studio.

See also: AWS API Documentation

Request Syntax

client.list_streaming_sessions(
    createdBy='string',
    nextToken='string',
    ownedBy='string',
    sessionIds='string',
    studioId='string'
)
type createdBy:

string

param createdBy:

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

type nextToken:

string

param nextToken:

The token for the next set of results, or null if there are no more results.

type ownedBy:

string

param ownedBy:

The user ID of the user that owns the streaming session.

type sessionIds:

string

param sessionIds:

A collection of session IDs.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'sessions': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'ec2InstanceType': 'string',
            'launchProfileId': 'string',
            'ownedBy': 'string',
            'sessionId': 'string',
            'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusCode': 'STREAMING_SESSION_READY'|'STREAMING_SESSION_DELETED'|'STREAMING_SESSION_CREATE_IN_PROGRESS'|'STREAMING_SESSION_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'INSUFFICIENT_CAPACITY'|'ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR'|'NETWORK_CONNECTION_ERROR'|'INITIALIZATION_SCRIPT_ERROR'|'DECRYPT_STREAMING_IMAGE_ERROR'|'NETWORK_INTERFACE_ERROR',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            },
            'terminateAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    Success

    • nextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • sessions (list) --

      A collection of streaming sessions.

      • (dict) --

        • arn (string) --

          The ARN of the resource.

        • createdAt (datetime) --

          The Unix epoch timestamp in seconds for when the resource was created.

        • createdBy (string) --

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

        • ec2InstanceType (string) --

          The EC2 Instance type used for the streaming session.

        • launchProfileId (string) --

          The ID of the launch profile used to control access from the streaming session.

        • ownedBy (string) --

          The user ID of the user that owns the streaming session.

        • sessionId (string) --

          The session ID.

        • state (string) --

          The current state.

        • statusCode (string) --

          The status code.

        • statusMessage (string) --

          The status message for the streaming session.

        • streamingImageId (string) --

          The ID of the streaming image.

        • tags (dict) --

          A collection of labels, in the form of key:value pairs, that apply to this resource.

          • (string) --

            • (string) --

        • terminateAt (datetime) --

          The time the streaming session will automatically terminate if not terminated by the user.

        • updatedAt (datetime) --

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy (string) --

          The user ID of the user that most recently updated the resource.