ListStreamingSessions¶

class NimbleStudio.Paginator.ListStreamingSessions¶

paginator = client.get_paginator('list_streaming_sessions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from NimbleStudio.Client.list_streaming_sessions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    createdBy='string',
    ownedBy='string',
    sessionIds='string',
    studioId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

createdBy (string) -- Filters the request to streaming sessions created by the given user.
ownedBy (string) -- Filters the request to streaming session owned by the given user
sessionIds (string) -- Filters the request to only the provided session IDs.
studioId (string) --
[REQUIRED]

The studio ID.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'sessions': [
        {
            'arn': 'string',
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'backupMode': 'AUTOMATIC'|'DEACTIVATED',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'ec2InstanceType': 'string',
            'launchProfileId': 'string',
            'maxBackupsToRetain': 123,
            'ownedBy': 'string',
            'sessionId': 'string',
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'startedAt': datetime(2015, 1, 1),
            'startedBy': 'string',
            'startedFromBackupId': 'string',
            'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED'|'STOP_IN_PROGRESS'|'START_IN_PROGRESS'|'STOPPED'|'STOP_FAILED'|'START_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'|'STREAMING_SESSION_STOPPED'|'STREAMING_SESSION_STARTED'|'STREAMING_SESSION_STOP_IN_PROGRESS'|'STREAMING_SESSION_START_IN_PROGRESS'|'AMI_VALIDATION_ERROR',
            'statusMessage': 'string',
            'stopAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'stoppedBy': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            },
            'terminateAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            },
            'volumeRetentionMode': 'RETAIN'|'DELETE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- sessions (list) --
  
  A collection of streaming sessions.
  - (dict) --
    
    A streaming session is a virtual workstation created using a particular launch profile.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - automaticTerminationMode (string) --
      
      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.
      - When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
      - When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.
      This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .
    - backupMode (string) --
      
      Shows the current backup setting of the session.
    - 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.
    - 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.
    - maxBackupsToRetain (integer) --
      
      The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.
    - 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.
    - sessionId (string) --
      
      The session ID.
    - sessionPersistenceMode (string) --
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - startedAt (datetime) --
      
      The time the session entered START_IN_PROGRESS state.
    - startedBy (string) --
      
      The user ID of the user that started the streaming session.
    - startedFromBackupId (string) --
      
      The backup ID used to restore a streaming session.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the streaming session.
    - stopAt (datetime) --
      
      The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
    - stoppedAt (datetime) --
      
      The time the session entered STOP_IN_PROGRESS state.
    - stoppedBy (string) --
      
      The user ID of the user that stopped 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 ISO timestamp in seconds for when the resource was updated.
    - updatedBy (string) --
      
      The user ID of the user that most recently updated the resource.
    - volumeConfiguration (dict) --
      
      Custom volume configuration for the root volumes that are attached to streaming sessions.
      
      This parameter is only allowed when sessionPersistenceMode is ACTIVATED .
      - iops (integer) --
        
        The number of I/O operations per second for the root volume that is attached to streaming session.
      - size (integer) --
        
        The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.
      - throughput (integer) --
        
        The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.
    - volumeRetentionMode (string) --
      
      Determine if an EBS volume created from this streaming session will be backed up.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

ListStreamingSessions¶