AWS API Changes

2024/07/12 - AmazonNimbleStudio - 49 new api methods

GetStreamingSessionStream (new)

Gets a StreamingSessionStream for a streaming session.

Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.

After the StreamingSessionStream changes to the READY state, 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 streaming session ID.

type streamId:

string

param streamId:

[REQUIRED]

The streaming session 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) --
- 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.

GetEula (new)

Link ¶

Get EULA.

See also: AWS API Documentation

Request Syntax

client.get_eula(
    eulaId='string'
)

type eulaId:

string

param eulaId:

[REQUIRED]

The EULA ID.

rtype:

dict

returns:

Response Syntax

{
    'eula': {
        'content': 'string',
        'createdAt': datetime(2015, 1, 1),
        'eulaId': 'string',
        'name': 'string',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- eula (dict) --
  
  The EULA.
  - content (string) --
    
    The EULA content.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - eulaId (string) --
    
    The EULA ID.
  - name (string) --
    
    The name for the EULA.
  - updatedAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was updated.

ListStudios (new)

Link ¶

List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

client.list_studios(
    nextToken='string'
)

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'studios': [
        {
            'adminRoleArn': 'string',
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'displayName': 'string',
            'homeRegion': 'string',
            'ssoClientId': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
            'statusMessage': 'string',
            'studioEncryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
            },
            'studioId': 'string',
            'studioName': 'string',
            'studioUrl': 'string',
            'tags': {
                'string': 'string'
            },
            'updatedAt': datetime(2015, 1, 1),
            'userRoleArn': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- studios (list) --
  
  A collection of studios.
  - (dict) --
    
    Represents a studio resource.
    
    A studio is the core resource used with Nimble Studio. You must create a studio first, before any other resource type can be created. All other resources you create and manage in Nimble Studio are contained within a studio.
    
    When creating a studio, you must provides two IAM roles for use with the Nimble Studio portal. These roles are assumed by your users when they log in to the Nimble Studio portal via IAM Identity Center and your identity source.
    
    The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.
    
    The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.
    
    Your studio roles must trust the identity.nimble.amazonaws.com service principal to function properly.
    - adminRoleArn (string) --
      
      The IAM role that studio admins assume when logging in to the Nimble Studio portal.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - createdAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was created.
    - displayName (string) --
      
      A friendly name for the studio.
    - homeRegion (string) --
      
      The Amazon Web Services Region where the studio resource is located.
    - ssoClientId (string) --
      
      The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
    - state (string) --
      
      The current state of the studio resource.
    - statusCode (string) --
      
      Status codes that provide additional detail on the studio state.
    - statusMessage (string) --
      
      Additional detail on the studio state.
    - studioEncryptionConfiguration (dict) --
      
      Configuration of the encryption method that is used for the studio.
      - keyArn (string) --
        
        The ARN for a KMS key that is used to encrypt studio data.
      - keyType (string) --
        
        The type of KMS key that is used to encrypt studio data.
    - studioId (string) --
      
      The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
    - studioName (string) --
      
      The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
    - studioUrl (string) --
      
      The address of the web page for the studio.
    - tags (dict) --
      
      A collection of labels, in the form of key-value pairs, that apply to this resource.
      - (string) --
        
        (string) --
    - updatedAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was updated.
    - userRoleArn (string) --
      
      The IAM role that studio users assume when logging in to the Nimble Studio portal.

GetLaunchProfile (new)

Link ¶

Get a launch profile.

See also: AWS API Documentation

Request Syntax

client.get_launch_profile(
    launchProfileId='string',
    studioId='string'
)

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
        'statusMessage': 'string',
        'streamConfiguration': {
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionBackup': {
                'maxBackupsToRetain': 123,
                'mode': 'AUTOMATIC'|'DEACTIVATED'
            },
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ],
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            }
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The 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.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - 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.
    - clipboardMode (string) --
      
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
      
      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
    - sessionBackup (dict) --
      
      Information about the streaming session backup.
      - maxBackupsToRetain (integer) --
        
        The maximum number of backups that each streaming session created from this launch profile can have.
      - mode (string) --
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
    - sessionPersistenceMode (string) --
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - sessionStorage (dict) --
      
      The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded.
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - 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.
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - 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.
  - validationResults (list) --
    
    The list of the latest validation results.
    - (dict) --
      
      The launch profile validation result.
      - state (string) --
        
        The current state.
      - statusCode (string) --
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
      - statusMessage (string) --
        
        The status message for the validation result.
      - type (string) --
        
        The type of the validation result.

DeleteLaunchProfileMember (new)

Link ¶

Delete a user from launch profile membership.

See also: AWS API Documentation

Request Syntax

client.delete_launch_profile_member(
    clientToken='string',
    launchProfileId='string',
    principalId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

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.

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type principalId:

string

param principalId:

[REQUIRED]

The principal ID. This currently supports a IAM Identity Center UserId.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

DeleteStreamingImage (new)

Link ¶

Delete streaming image.

See also: AWS API Documentation

Request Syntax

client.delete_streaming_image(
    clientToken='string',
    streamingImageId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type streamingImageId:

string

param streamingImageId:

[REQUIRED]

The streaming image ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'streamingImage': {
        'arn': 'string',
        'description': 'string',
        'ec2ImageId': 'string',
        'encryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'CUSTOMER_MANAGED_KEY'
        },
        'eulaIds': [
            'string',
        ],
        'name': 'string',
        'owner': 'string',
        'platform': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- streamingImage (dict) --
  
  The streaming image.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either Windows or Linux.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - 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) --

GetStudioComponent (new)

Link ¶

Gets a studio component resource.

See also: AWS API Documentation

Request Syntax

client.get_studio_component(
    studioComponentId='string',
    studioId='string'
)

type studioComponentId:

string

param studioComponentId:

[REQUIRED]

The studio component ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'studioComponent': {
        'arn': 'string',
        'configuration': {
            'activeDirectoryConfiguration': {
                'computerAttributes': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'directoryId': 'string',
                'organizationalUnitDistinguishedName': 'string'
            },
            'computeFarmConfiguration': {
                'activeDirectoryUser': 'string',
                'endpoint': 'string'
            },
            'licenseServiceConfiguration': {
                'endpoint': 'string'
            },
            'sharedFileSystemConfiguration': {
                'endpoint': 'string',
                'fileSystemId': 'string',
                'linuxMountPoint': 'string',
                'shareName': 'string',
                'windowsMountDrive': 'string'
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SecurityGroupIds': [
            'string',
        ],
        'initializationScripts': [
            {
                'launchProfileProtocolVersion': 'string',
                'platform': 'LINUX'|'WINDOWS',
                'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                'script': 'string'
            },
        ],
        'name': 'string',
        'runtimeRoleArn': 'string',
        'scriptParameters': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'secureInitializationRoleArn': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
        'statusMessage': 'string',
        'studioComponentId': 'string',
        'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
        'tags': {
            'string': 'string'
        },
        'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- studioComponent (dict) --
  
  Information about the studio component.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - configuration (dict) --
    
    The configuration of the studio component, based on component type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - activeDirectoryConfiguration (dict) --
      
      The configuration for a Directory Service for Microsoft Active Directory studio resource.
      - computerAttributes (list) --
        
        A collection of custom attributes for an Active Directory computer.
        
        (dict) --
        
        An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
        
        name (string) --
        
        The name for the LDAP attribute.
        
        value (string) --
        
        The value for the LDAP attribute.
      - directoryId (string) --
        
        The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
      - organizationalUnitDistinguishedName (string) --
        
        The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
    - computeFarmConfiguration (dict) --
      
      The configuration for a render farm that is associated with a studio resource.
      - activeDirectoryUser (string) --
        
        The name of an Active Directory user that is used on ComputeFarm worker instances.
      - endpoint (string) --
        
        The endpoint of the ComputeFarm that is accessed by the studio component resource.
    - licenseServiceConfiguration (dict) --
      
      The configuration for a license service that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the license service that is accessed by the studio component resource.
    - sharedFileSystemConfiguration (dict) --
      
      The configuration for a shared file storage system that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the shared file system that is accessed by the studio component resource.
      - fileSystemId (string) --
        
        The unique identifier for a file system.
      - linuxMountPoint (string) --
        
        The mount location for a shared file system on a Linux virtual workstation.
      - shareName (string) --
        
        The name of the file share.
      - windowsMountDrive (string) --
        
        The mount location for a shared file system on a Windows virtual workstation.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the studio component.
  - description (string) --
    
    A human-readable description for the studio component resource.
  - ec2SecurityGroupIds (list) --
    
    The EC2 security groups that control access to the studio component.
    - (string) --
  - initializationScripts (list) --
    
    Initialization scripts for studio components.
    - (dict) --
      
      Initialization scripts for studio components.
      - launchProfileProtocolVersion (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
      - platform (string) --
        
        The platform of the initialization script, either Windows or Linux.
      - runContext (string) --
        
        The method to use when running the initialization script.
      - script (string) --
        
        The initialization script.
  - name (string) --
    
    A friendly name for the studio component resource.
  - runtimeRoleArn (string) --
    
    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
  - scriptParameters (list) --
    
    Parameters for the studio component scripts.
    - (dict) --
      
      A parameter for a studio component script, in the form of a key-value pair.
      - key (string) --
        
        A script parameter key.
      - value (string) --
        
        A script parameter value.
  - secureInitializationRoleArn (string) --
    
    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the studio component.
  - studioComponentId (string) --
    
    The unique identifier for a studio component resource.
  - subtype (string) --
    
    The specific subtype of a studio component.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of the studio component.
  - 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.

GetLaunchProfileDetails (new)

Link ¶

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.

See also: AWS API Documentation

Request Syntax

client.get_launch_profile_details(
    launchProfileId='string',
    studioId='string'
)

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
        'statusMessage': 'string',
        'streamConfiguration': {
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionBackup': {
                'maxBackupsToRetain': 123,
                'mode': 'AUTOMATIC'|'DEACTIVATED'
            },
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ],
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            }
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    },
    'streamingImages': [
        {
            'arn': 'string',
            'description': 'string',
            'ec2ImageId': 'string',
            'encryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'CUSTOMER_MANAGED_KEY'
            },
            'eulaIds': [
                'string',
            ],
            'name': 'string',
            'owner': 'string',
            'platform': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'studioComponentSummaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'name': 'string',
            'studioComponentId': 'string',
            'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
            'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The 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.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - 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.
    - clipboardMode (string) --
      
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
      
      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
    - sessionBackup (dict) --
      
      Information about the streaming session backup.
      - maxBackupsToRetain (integer) --
        
        The maximum number of backups that each streaming session created from this launch profile can have.
      - mode (string) --
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
    - sessionPersistenceMode (string) --
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - sessionStorage (dict) --
      
      The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded.
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - 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.
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - 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.
  - validationResults (list) --
    
    The list of the latest validation results.
    - (dict) --
      
      The launch profile validation result.
      - state (string) --
        
        The current state.
      - statusCode (string) --
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
      - statusMessage (string) --
        
        The status message for the validation result.
      - type (string) --
        
        The type of the validation result.
- streamingImages (list) --
  
  A collection of streaming images.
  - (dict) --
    
    Represents a streaming image resource.
    
    Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
    
    Amazon provides a number of streaming images that include popular 3rd-party software.
    
    You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - description (string) --
      
      A human-readable description of the streaming image.
    - ec2ImageId (string) --
      
      The ID of an EC2 machine image with which to create the streaming image.
    - encryptionConfiguration (dict) --
      
      The encryption configuration.
      - keyArn (string) --
        
        The ARN for a KMS key that is used to encrypt studio data.
      - keyType (string) --
        
        The type of KMS key that is used to encrypt studio data.
    - eulaIds (list) --
      
      The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
      - (string) --
    - name (string) --
      
      A friendly name for a streaming image resource.
    - owner (string) --
      
      The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
    - platform (string) --
      
      The platform of the streaming image, either Windows or Linux.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the streaming image.
    - 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) --
- studioComponentSummaries (list) --
  
  A collection of studio component summaries.
  - (dict) --
    
    The studio component's summary.
    - createdAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was created.
    - createdBy (string) --
      
      The user ID of the user that created the studio component.
    - description (string) --
      
      The description.
    - name (string) --
      
      The name for the studio component.
    - studioComponentId (string) --
      
      The unique identifier for a studio component resource.
    - subtype (string) --
      
      The specific subtype of a studio component.
    - type (string) --
      
      The type of the studio component.
    - 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.

DeleteStreamingSession (new)

Link ¶

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:

This field is autopopulated if not provided.

type sessionId:

string

param sessionId:

[REQUIRED]

The streaming session ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'session': {
        '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'
    }
}

Response Structure

(dict) --
- session (dict) --
  
  The session.
  - 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.

ListLaunchProfileMembers (new)

Link ¶

Get all users in a given launch profile membership.

See also: AWS API Documentation

Request Syntax

client.list_launch_profile_members(
    launchProfileId='string',
    maxResults=123,
    nextToken='string',
    studioId='string'
)

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type maxResults:

integer

param maxResults:

The max number of results to return in the response.

type nextToken:

string

param nextToken:

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

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'members': [
        {
            'identityStoreId': 'string',
            'persona': 'USER',
            'principalId': 'string',
            'sid': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- members (list) --
  
  A list of members.
  - (dict) --
    
    Studio admins can use launch profile membership to delegate launch profile access to studio users in the Nimble Studio portal without writing or maintaining complex IAM policies. A launch profile member is a user association from your studio identity source who is granted permissions to a launch profile.
    
    A launch profile member (type USER) provides the following permissions to that launch profile:
    - GetLaunchProfile
    - GetLaunchProfileInitialization
    - GetLaunchProfileMembers
    - GetLaunchProfileMember
    - CreateStreamingSession
    - GetLaunchProfileDetails
    - identityStoreId (string) --
      
      The ID of the identity store.
    - persona (string) --
      
      The persona.
    - principalId (string) --
      
      The principal ID.
    - sid (string) --
      
      The Active Directory Security Identifier for this user, if available.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

GetStudio (new)

Link ¶

Get a studio resource.

See also: AWS API Documentation

Request Syntax

client.get_studio(
    studioId='string'
)

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'studio': {
        'adminRoleArn': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'displayName': 'string',
        'homeRegion': 'string',
        'ssoClientId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
        'statusMessage': 'string',
        'studioEncryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'studioId': 'string',
        'studioName': 'string',
        'studioUrl': 'string',
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'userRoleArn': 'string'
    }
}

Response Structure

(dict) --
- studio (dict) --
  
  Information about a studio.
  - adminRoleArn (string) --
    
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - displayName (string) --
    
    A friendly name for the studio.
  - homeRegion (string) --
    
    The Amazon Web Services Region where the studio resource is located.
  - ssoClientId (string) --
    
    The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
  - state (string) --
    
    The current state of the studio resource.
  - statusCode (string) --
    
    Status codes that provide additional detail on the studio state.
  - statusMessage (string) --
    
    Additional detail on the studio state.
  - studioEncryptionConfiguration (dict) --
    
    Configuration of the encryption method that is used for the studio.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - studioId (string) --
    
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - studioName (string) --
    
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - studioUrl (string) --
    
    The address of the web page for the studio.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was updated.
  - userRoleArn (string) --
    
    The IAM role that studio users assume when logging in to the Nimble Studio portal.

PutStudioMembers (new)

Link ¶

Add/update users with given persona to studio membership.

See also: AWS API Documentation

Request Syntax

client.put_studio_members(
    clientToken='string',
    identityStoreId='string',
    members=[
        {
            'persona': 'ADMINISTRATOR',
            'principalId': 'string'
        },
    ],
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type identityStoreId:

string

param identityStoreId:

[REQUIRED]

The ID of the identity store.

type members:

list

param members:

[REQUIRED]

A list of members.

(dict) --

A new studio user's membership.
- persona (string) -- [REQUIRED]
  
  The persona.
- principalId (string) -- [REQUIRED]
  
  The principal ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

StartStudioSSOConfigurationRepair (new)

Link ¶

Repairs the IAM Identity Center configuration for a given studio.

If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.

If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the READY state.

After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.

See also: AWS API Documentation

Request Syntax

client.start_studio_sso_configuration_repair(
    clientToken='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'studio': {
        'adminRoleArn': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'displayName': 'string',
        'homeRegion': 'string',
        'ssoClientId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
        'statusMessage': 'string',
        'studioEncryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'studioId': 'string',
        'studioName': 'string',
        'studioUrl': 'string',
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'userRoleArn': 'string'
    }
}

Response Structure

(dict) --
- studio (dict) --
  
  Information about a studio.
  - adminRoleArn (string) --
    
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - displayName (string) --
    
    A friendly name for the studio.
  - homeRegion (string) --
    
    The Amazon Web Services Region where the studio resource is located.
  - ssoClientId (string) --
    
    The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
  - state (string) --
    
    The current state of the studio resource.
  - statusCode (string) --
    
    Status codes that provide additional detail on the studio state.
  - statusMessage (string) --
    
    Additional detail on the studio state.
  - studioEncryptionConfiguration (dict) --
    
    Configuration of the encryption method that is used for the studio.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - studioId (string) --
    
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - studioName (string) --
    
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - studioUrl (string) --
    
    The address of the web page for the studio.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was updated.
  - userRoleArn (string) --
    
    The IAM role that studio users assume when logging in to the Nimble Studio portal.

DeleteLaunchProfile (new)

Link ¶

Permanently delete a launch profile.

See also: AWS API Documentation

Request Syntax

client.delete_launch_profile(
    clientToken='string',
    launchProfileId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
        'statusMessage': 'string',
        'streamConfiguration': {
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionBackup': {
                'maxBackupsToRetain': 123,
                'mode': 'AUTOMATIC'|'DEACTIVATED'
            },
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ],
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            }
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The 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.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - 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.
    - clipboardMode (string) --
      
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
      
      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
    - sessionBackup (dict) --
      
      Information about the streaming session backup.
      - maxBackupsToRetain (integer) --
        
        The maximum number of backups that each streaming session created from this launch profile can have.
      - mode (string) --
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
    - sessionPersistenceMode (string) --
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - sessionStorage (dict) --
      
      The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded.
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - 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.
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - 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.
  - validationResults (list) --
    
    The list of the latest validation results.
    - (dict) --
      
      The launch profile validation result.
      - state (string) --
        
        The current state.
      - statusCode (string) --
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
      - statusMessage (string) --
        
        The status message for the validation result.
      - type (string) --
        
        The type of the validation result.

StartStreamingSession (new)

Link ¶

Transitions sessions from the STOPPED state into the READY state. The START_IN_PROGRESS state is the intermediate state between the STOPPED and READY states.

See also: AWS API Documentation

Request Syntax

client.start_streaming_session(
    backupId='string',
    clientToken='string',
    sessionId='string',
    studioId='string'
)

type backupId:

string

param backupId:

The ID of the backup.

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type sessionId:

string

param sessionId:

[REQUIRED]

The streaming session ID for the StartStreamingSessionRequest.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID for the StartStreamingSessionRequest.

rtype:

dict

returns:

Response Syntax

{
    'session': {
        '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'
    }
}

Response Structure

(dict) --
- session (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.

GetStreamingSession (new)

Link ¶

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 streaming session ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'session': {
        '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'
    }
}

Response Structure

(dict) --
- session (dict) --
  
  The session.
  - 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.

ListTagsForResource (new)

Link ¶

Gets the tags for a resource, given its Amazon Resource Names (ARN).

This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  A collection of labels, in the form of key-value pairs, that apply to this resource.
  - (string) --
    - (string) --

UpdateStreamingImage (new)

Link ¶

Update streaming image.

See also: AWS API Documentation

Request Syntax

client.update_streaming_image(
    clientToken='string',
    description='string',
    name='string',
    streamingImageId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type description:

string

param description:

The description.

type name:

string

param name:

The name for the streaming image.

type streamingImageId:

string

param streamingImageId:

[REQUIRED]

The streaming image ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'streamingImage': {
        'arn': 'string',
        'description': 'string',
        'ec2ImageId': 'string',
        'encryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'CUSTOMER_MANAGED_KEY'
        },
        'eulaIds': [
            'string',
        ],
        'name': 'string',
        'owner': 'string',
        'platform': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- streamingImage (dict) --
  
  Represents a streaming image resource.
  
  Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
  
  Amazon provides a number of streaming images that include popular 3rd-party software.
  
  You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either Windows or Linux.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - 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) --

AcceptEulas (new)

Link ¶

Accept EULAs.

See also: AWS API Documentation

Request Syntax

client.accept_eulas(
    clientToken='string',
    eulaIds=[
        'string',
    ],
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type eulaIds:

list

param eulaIds:

The EULA ID.

(string) --

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'eulaAcceptances': [
        {
            'acceptedAt': datetime(2015, 1, 1),
            'acceptedBy': 'string',
            'accepteeId': 'string',
            'eulaAcceptanceId': 'string',
            'eulaId': 'string'
        },
    ]
}

Response Structure

(dict) --
- eulaAcceptances (list) --
  
  A collection of EULA acceptances.
  - (dict) --
    
    The acceptance of a EULA, required to use Amazon-provided streaming images.
    - acceptedAt (datetime) --
      
      The ISO timestamp in seconds for when the EULA was accepted.
    - acceptedBy (string) --
      
      The ID of the person who accepted the EULA.
    - accepteeId (string) --
      
      The ID of the acceptee.
    - eulaAcceptanceId (string) --
      
      The EULA acceptance ID.
    - eulaId (string) --
      
      The EULA ID.

CreateStreamingImage (new)

Link ¶

Creates a streaming image resource in a studio.

See also: AWS API Documentation

Request Syntax

client.create_streaming_image(
    clientToken='string',
    description='string',
    ec2ImageId='string',
    name='string',
    studioId='string',
    tags={
        'string': 'string'
    }
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type description:

string

param description:

A human-readable description of the streaming image.

type ec2ImageId:

string

param ec2ImageId:

[REQUIRED]

The ID of an EC2 machine image with which to create this streaming image.

type name:

string

param name:

[REQUIRED]

A friendly name for a streaming image resource.

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

{
    'streamingImage': {
        'arn': 'string',
        'description': 'string',
        'ec2ImageId': 'string',
        'encryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'CUSTOMER_MANAGED_KEY'
        },
        'eulaIds': [
            'string',
        ],
        'name': 'string',
        'owner': 'string',
        'platform': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- streamingImage (dict) --
  
  The streaming image.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either Windows or Linux.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - 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) --

ListEulaAcceptances (new)

Link ¶

List EULA acceptances.

See also: AWS API Documentation

Request Syntax

client.list_eula_acceptances(
    eulaIds=[
        'string',
    ],
    nextToken='string',
    studioId='string'
)

type eulaIds:

list

param eulaIds:

The list of EULA IDs that have been previously accepted.

(string) --

type nextToken:

string

param nextToken:

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

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'eulaAcceptances': [
        {
            'acceptedAt': datetime(2015, 1, 1),
            'acceptedBy': 'string',
            'accepteeId': 'string',
            'eulaAcceptanceId': 'string',
            'eulaId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- eulaAcceptances (list) --
  
  A collection of EULA acceptances.
  - (dict) --
    
    The acceptance of a EULA, required to use Amazon-provided streaming images.
    - acceptedAt (datetime) --
      
      The ISO timestamp in seconds for when the EULA was accepted.
    - acceptedBy (string) --
      
      The ID of the person who accepted the EULA.
    - accepteeId (string) --
      
      The ID of the acceptee.
    - eulaAcceptanceId (string) --
      
      The EULA acceptance ID.
    - eulaId (string) --
      
      The EULA ID.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

GetStreamingImage (new)

Link ¶

Get streaming image.

See also: AWS API Documentation

Request Syntax

client.get_streaming_image(
    streamingImageId='string',
    studioId='string'
)

type streamingImageId:

string

param streamingImageId:

[REQUIRED]

The streaming image ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'streamingImage': {
        'arn': 'string',
        'description': 'string',
        'ec2ImageId': 'string',
        'encryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'CUSTOMER_MANAGED_KEY'
        },
        'eulaIds': [
            'string',
        ],
        'name': 'string',
        'owner': 'string',
        'platform': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
        'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
        'statusMessage': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- streamingImage (dict) --
  
  The streaming image.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either Windows or Linux.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - 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) --

ListStreamingSessions (new)

Link ¶

Lists the streaming sessions 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:

Filters the request to streaming sessions created by the given user.

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:

Filters the request to streaming session owned by the given user

type sessionIds:

string

param sessionIds:

Filters the request to only the provided session IDs.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

(dict) --
- 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) --
    
    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.

UpdateLaunchProfileMember (new)

Link ¶

Update a user persona in launch profile membership.

See also: AWS API Documentation

Request Syntax

client.update_launch_profile_member(
    clientToken='string',
    launchProfileId='string',
    persona='USER',
    principalId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type persona:

string

param persona:

[REQUIRED]

The persona.

type principalId:

string

param principalId:

[REQUIRED]

The principal ID. This currently supports a IAM Identity Center UserId.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'member': {
        'identityStoreId': 'string',
        'persona': 'USER',
        'principalId': 'string',
        'sid': 'string'
    }
}

Response Structure

(dict) --
- member (dict) --
  
  The updated member.
  - identityStoreId (string) --
    
    The ID of the identity store.
  - persona (string) --
    
    The persona.
  - principalId (string) --
    
    The principal ID.
  - sid (string) --
    
    The Active Directory Security Identifier for this user, if available.

PutLaunchProfileMembers (new)

Link ¶

Add/update users with given persona to launch profile membership.

See also: AWS API Documentation

Request Syntax

client.put_launch_profile_members(
    clientToken='string',
    identityStoreId='string',
    launchProfileId='string',
    members=[
        {
            'persona': 'USER',
            'principalId': 'string'
        },
    ],
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type identityStoreId:

string

param identityStoreId:

[REQUIRED]

The ID of the identity store.

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type members:

list

param members:

[REQUIRED]

A list of members.

(dict) --

A new member that is added to a launch profile.
- persona (string) -- [REQUIRED]
  
  The persona.
- principalId (string) -- [REQUIRED]
  
  The principal ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetLaunchProfileMember (new)

Link ¶

Get a user persona in launch profile membership.

See also: AWS API Documentation

Request Syntax

client.get_launch_profile_member(
    launchProfileId='string',
    principalId='string',
    studioId='string'
)

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type principalId:

string

param principalId:

[REQUIRED]

The principal ID. This currently supports a IAM Identity Center UserId.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'member': {
        'identityStoreId': 'string',
        'persona': 'USER',
        'principalId': 'string',
        'sid': 'string'
    }
}

Response Structure

(dict) --
- member (dict) --
  
  The member.
  - identityStoreId (string) --
    
    The ID of the identity store.
  - persona (string) --
    
    The persona.
  - principalId (string) --
    
    The principal ID.
  - sid (string) --
    
    The Active Directory Security Identifier for this user, if available.

ListStreamingImages (new)

Link ¶

List the streaming image resources available to this studio.

This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.

See also: AWS API Documentation

Request Syntax

client.list_streaming_images(
    nextToken='string',
    owner='string',
    studioId='string'
)

type nextToken:

string

param nextToken:

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

type owner:

string

param owner:

Filter this request to streaming images with the given owner

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'streamingImages': [
        {
            'arn': 'string',
            'description': 'string',
            'ec2ImageId': 'string',
            'encryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'CUSTOMER_MANAGED_KEY'
            },
            'eulaIds': [
                'string',
            ],
            'name': 'string',
            'owner': 'string',
            'platform': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- streamingImages (list) --
  
  A collection of streaming images.
  - (dict) --
    
    Represents a streaming image resource.
    
    Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
    
    Amazon provides a number of streaming images that include popular 3rd-party software.
    
    You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - description (string) --
      
      A human-readable description of the streaming image.
    - ec2ImageId (string) --
      
      The ID of an EC2 machine image with which to create the streaming image.
    - encryptionConfiguration (dict) --
      
      The encryption configuration.
      - keyArn (string) --
        
        The ARN for a KMS key that is used to encrypt studio data.
      - keyType (string) --
        
        The type of KMS key that is used to encrypt studio data.
    - eulaIds (list) --
      
      The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
      - (string) --
    - name (string) --
      
      A friendly name for a streaming image resource.
    - owner (string) --
      
      The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
    - platform (string) --
      
      The platform of the streaming image, either Windows or Linux.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the streaming image.
    - 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) --

UpdateLaunchProfile (new)

Link ¶

Update a launch profile.

See also: AWS API Documentation

Request Syntax

client.update_launch_profile(
    clientToken='string',
    description='string',
    launchProfileId='string',
    launchProfileProtocolVersions=[
        'string',
    ],
    name='string',
    streamConfiguration={
        'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
        'clipboardMode': 'ENABLED'|'DISABLED',
        'ec2InstanceTypes': [
            'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
        ],
        'maxSessionLengthInMinutes': 123,
        'maxStoppedSessionLengthInMinutes': 123,
        'sessionBackup': {
            'maxBackupsToRetain': 123,
            'mode': 'AUTOMATIC'|'DEACTIVATED'
        },
        'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
        'sessionStorage': {
            'mode': [
                'UPLOAD',
            ],
            'root': {
                'linux': 'string',
                'windows': 'string'
            }
        },
        'streamingImageIds': [
            'string',
        ],
        'volumeConfiguration': {
            'iops': 123,
            'size': 123,
            'throughput': 123
        }
    },
    studioComponentIds=[
        'string',
    ],
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type description:

string

param description:

The description.

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type launchProfileProtocolVersions:

list

param launchProfileProtocolVersions:

The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

(string) --

The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

type name:

string

param name:

The name for the launch profile.

type streamConfiguration:

dict

param streamConfiguration:

A configuration for a streaming session.

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.
clipboardMode (string) -- [REQUIRED]

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
ec2InstanceTypes (list) -- [REQUIRED]

The EC2 instance types that users can select from when launching a streaming session with this launch profile.
- (string) --
maxSessionLengthInMinutes (integer) --

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
maxStoppedSessionLengthInMinutes (integer) --

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
sessionBackup (dict) --

Configures how streaming sessions are backed up when launched from this launch profile.
- maxBackupsToRetain (integer) --
  
  The maximum number of backups that each streaming session created from this launch profile can have.
- mode (string) --
  
  Specifies how artists sessions are backed up.
  
  Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
sessionPersistenceMode (string) --

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
sessionStorage (dict) --

The upload storage for a streaming workstation that is created using this launch profile.
- mode (list) -- [REQUIRED]
  
  Allows artists to upload files to their workstations. The only valid option is UPLOAD.
  - (string) --
- root (dict) --
  
  The configuration for the upload storage root of the streaming session.
  - linux (string) --
    
    The folder path in Linux workstations where files are uploaded.
  - windows (string) --
    
    The folder path in Windows workstations where files are uploaded.
streamingImageIds (list) -- [REQUIRED]

The streaming images that users can select from when launching a streaming session with this launch profile.
- (string) --
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.

type studioComponentIds:

list

param studioComponentIds:

Unique identifiers for a collection of studio components that can be used with this launch profile.

(string) --

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
        'statusMessage': 'string',
        'streamConfiguration': {
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionBackup': {
                'maxBackupsToRetain': 123,
                'mode': 'AUTOMATIC'|'DEACTIVATED'
            },
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ],
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            }
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The 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.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - 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.
    - clipboardMode (string) --
      
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
      
      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
    - sessionBackup (dict) --
      
      Information about the streaming session backup.
      - maxBackupsToRetain (integer) --
        
        The maximum number of backups that each streaming session created from this launch profile can have.
      - mode (string) --
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
    - sessionPersistenceMode (string) --
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - sessionStorage (dict) --
      
      The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded.
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - 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.
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - 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.
  - validationResults (list) --
    
    The list of the latest validation results.
    - (dict) --
      
      The launch profile validation result.
      - state (string) --
        
        The current state.
      - statusCode (string) --
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
      - statusMessage (string) --
        
        The status message for the validation result.
      - type (string) --
        
        The type of the validation result.

CreateStudio (new)

Link ¶

Create a new studio.

When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.

The user role must have the AmazonNimbleStudio-StudioUser managed policy attached for the portal to function properly.

The admin role must have the AmazonNimbleStudio-StudioAdmin managed policy attached for the portal to function properly.

You may optionally specify a KMS key in the StudioEncryptionConfiguration.

In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling CreateStudio to encrypt this data using a key you own and manage.

When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.

If you delete this grant, the studio will no longer be accessible to your portal users.

If you delete the studio KMS key, your studio will no longer be accessible.

See also: AWS API Documentation

Request Syntax

client.create_studio(
    adminRoleArn='string',
    clientToken='string',
    displayName='string',
    studioEncryptionConfiguration={
        'keyArn': 'string',
        'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
    },
    studioName='string',
    tags={
        'string': 'string'
    },
    userRoleArn='string'
)

type adminRoleArn:

string

param adminRoleArn:

[REQUIRED]

The IAM role that studio admins will assume when logging in to the Nimble Studio portal.

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type displayName:

string

param displayName:

[REQUIRED]

A friendly name for the studio.

type studioEncryptionConfiguration:

dict

param studioEncryptionConfiguration:

The studio encryption configuration.

keyArn (string) --

The ARN for a KMS key that is used to encrypt studio data.
keyType (string) -- [REQUIRED]

The type of KMS key that is used to encrypt studio data.

type studioName:

string

param studioName:

[REQUIRED]

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

type tags:

dict

param tags:

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

(string) --
- (string) --

type userRoleArn:

string

param userRoleArn:

[REQUIRED]

The IAM role that studio users will assume when logging in to the Nimble Studio portal.

rtype:

dict

returns:

Response Syntax

{
    'studio': {
        'adminRoleArn': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'displayName': 'string',
        'homeRegion': 'string',
        'ssoClientId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
        'statusMessage': 'string',
        'studioEncryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'studioId': 'string',
        'studioName': 'string',
        'studioUrl': 'string',
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'userRoleArn': 'string'
    }
}

Response Structure

(dict) --
- studio (dict) --
  
  Information about a studio.
  - adminRoleArn (string) --
    
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - displayName (string) --
    
    A friendly name for the studio.
  - homeRegion (string) --
    
    The Amazon Web Services Region where the studio resource is located.
  - ssoClientId (string) --
    
    The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
  - state (string) --
    
    The current state of the studio resource.
  - statusCode (string) --
    
    Status codes that provide additional detail on the studio state.
  - statusMessage (string) --
    
    Additional detail on the studio state.
  - studioEncryptionConfiguration (dict) --
    
    Configuration of the encryption method that is used for the studio.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - studioId (string) --
    
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - studioName (string) --
    
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - studioUrl (string) --
    
    The address of the web page for the studio.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was updated.
  - userRoleArn (string) --
    
    The IAM role that studio users assume when logging in to the Nimble Studio portal.

DeleteStudio (new)

Link ¶

Delete a studio resource.

See also: AWS API Documentation

Request Syntax

client.delete_studio(
    clientToken='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'studio': {
        'adminRoleArn': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'displayName': 'string',
        'homeRegion': 'string',
        'ssoClientId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
        'statusMessage': 'string',
        'studioEncryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'studioId': 'string',
        'studioName': 'string',
        'studioUrl': 'string',
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'userRoleArn': 'string'
    }
}

Response Structure

(dict) --
- studio (dict) --
  
  Information about a studio.
  - adminRoleArn (string) --
    
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - displayName (string) --
    
    A friendly name for the studio.
  - homeRegion (string) --
    
    The Amazon Web Services Region where the studio resource is located.
  - ssoClientId (string) --
    
    The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
  - state (string) --
    
    The current state of the studio resource.
  - statusCode (string) --
    
    Status codes that provide additional detail on the studio state.
  - statusMessage (string) --
    
    Additional detail on the studio state.
  - studioEncryptionConfiguration (dict) --
    
    Configuration of the encryption method that is used for the studio.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - studioId (string) --
    
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - studioName (string) --
    
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - studioUrl (string) --
    
    The address of the web page for the studio.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was updated.
  - userRoleArn (string) --
    
    The IAM role that studio users assume when logging in to the Nimble Studio portal.

GetLaunchProfileInitialization (new)

Link ¶

Get a launch profile initialization.

See also: AWS API Documentation

Request Syntax

client.get_launch_profile_initialization(
    launchProfileId='string',
    launchProfileProtocolVersions=[
        'string',
    ],
    launchPurpose='string',
    platform='string',
    studioId='string'
)

type launchProfileId:

string

param launchProfileId:

[REQUIRED]

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

type launchProfileProtocolVersions:

list

param launchProfileProtocolVersions:

[REQUIRED]

The launch profile protocol versions supported by the client.

(string) --

type launchPurpose:

string

param launchPurpose:

[REQUIRED]

The launch purpose.

type platform:

string

param platform:

[REQUIRED]

The platform where this Launch Profile will be used, either Windows or Linux.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'launchProfileInitialization': {
        'activeDirectory': {
            'computerAttributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'directoryId': 'string',
            'directoryName': 'string',
            'dnsIpAddresses': [
                'string',
            ],
            'organizationalUnitDistinguishedName': 'string',
            'studioComponentId': 'string',
            'studioComponentName': 'string'
        },
        'ec2SecurityGroupIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersion': 'string',
        'launchPurpose': 'string',
        'name': 'string',
        'platform': 'LINUX'|'WINDOWS',
        'systemInitializationScripts': [
            {
                'runtimeRoleArn': 'string',
                'script': 'string',
                'secureInitializationRoleArn': 'string',
                'studioComponentId': 'string',
                'studioComponentName': 'string'
            },
        ],
        'userInitializationScripts': [
            {
                'runtimeRoleArn': 'string',
                'script': 'string',
                'secureInitializationRoleArn': 'string',
                'studioComponentId': 'string',
                'studioComponentName': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- launchProfileInitialization (dict) --
  
  The launch profile initialization.
  - activeDirectory (dict) --
    
    A LaunchProfileInitializationActiveDirectory resource.
    - computerAttributes (list) --
      
      A collection of custom attributes for an Active Directory computer.
      - (dict) --
        
        An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
        
        name (string) --
        
        The name for the LDAP attribute.
        
        value (string) --
        
        The value for the LDAP attribute.
    - directoryId (string) --
      
      The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.
    - directoryName (string) --
      
      The directory name.
    - dnsIpAddresses (list) --
      
      The DNS IP address.
      - (string) --
    - organizationalUnitDistinguishedName (string) --
      
      The name for the organizational unit distinguished name.
    - studioComponentId (string) --
      
      The unique identifier for a studio component resource.
    - studioComponentName (string) --
      
      The name for the studio component.
  - ec2SecurityGroupIds (list) --
    
    The EC2 security groups that control access to the studio component.
    - (string) --
  - launchProfileId (string) --
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersion (string) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - launchPurpose (string) --
    
    The launch purpose.
  - name (string) --
    
    The name for the launch profile.
  - platform (string) --
    
    The platform of the launch platform, either Windows or Linux.
  - systemInitializationScripts (list) --
    
    The system initializtion scripts.
    - (dict) --
      
      The launch profile initialization script is used when start streaming session runs.
      - runtimeRoleArn (string) --
        
        An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
      - script (string) --
        
        The initialization script.
      - secureInitializationRoleArn (string) --
        
        An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
      - studioComponentId (string) --
        
        The unique identifier for a studio component resource.
      - studioComponentName (string) --
        
        The name for the studio component.
  - userInitializationScripts (list) --
    
    The user initializtion scripts.
    - (dict) --
      
      The launch profile initialization script is used when start streaming session runs.
      - runtimeRoleArn (string) --
        
        An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
      - script (string) --
        
        The initialization script.
      - secureInitializationRoleArn (string) --
        
        An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
      - studioComponentId (string) --
        
        The unique identifier for a studio component resource.
      - studioComponentName (string) --
        
        The name for the studio component.

DeleteStudioMember (new)

Link ¶

Delete a user from studio membership.

See also: AWS API Documentation

Request Syntax

client.delete_studio_member(
    clientToken='string',
    principalId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type principalId:

string

param principalId:

[REQUIRED]

The principal ID. This currently supports a IAM Identity Center UserId.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

ListLaunchProfiles (new)

Link ¶

List all the launch profiles a studio.

See also: AWS API Documentation

Request Syntax

client.list_launch_profiles(
    maxResults=123,
    nextToken='string',
    principalId='string',
    states=[
        'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
    ],
    studioId='string'
)

type maxResults:

integer

param maxResults:

The max number of results to return in the response.

type nextToken:

string

param nextToken:

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

type principalId:

string

param principalId:

The principal ID. This currently supports a IAM Identity Center UserId.

type states:

list

param states:

Filter this request to launch profiles in any of the given states.

(string) --

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'launchProfiles': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'ec2SubnetIds': [
                'string',
            ],
            'launchProfileId': 'string',
            'launchProfileProtocolVersions': [
                'string',
            ],
            'name': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
            'statusMessage': 'string',
            'streamConfiguration': {
                'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
                'clipboardMode': 'ENABLED'|'DISABLED',
                'ec2InstanceTypes': [
                    'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
                ],
                'maxSessionLengthInMinutes': 123,
                'maxStoppedSessionLengthInMinutes': 123,
                'sessionBackup': {
                    'maxBackupsToRetain': 123,
                    'mode': 'AUTOMATIC'|'DEACTIVATED'
                },
                'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
                'sessionStorage': {
                    'mode': [
                        'UPLOAD',
                    ],
                    'root': {
                        'linux': 'string',
                        'windows': 'string'
                    }
                },
                'streamingImageIds': [
                    'string',
                ],
                'volumeConfiguration': {
                    'iops': 123,
                    'size': 123,
                    'throughput': 123
                }
            },
            'studioComponentIds': [
                'string',
            ],
            'tags': {
                'string': 'string'
            },
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'validationResults': [
                {
                    'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                    'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                    'statusMessage': 'string',
                    'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- launchProfiles (list) --
  
  A collection of launch profiles.
  - (dict) --
    
    A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).
    
    Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - createdAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was created.
    - createdBy (string) --
      
      The user ID of the user that created the launch profile.
    - description (string) --
      
      A human-readable description of the launch profile.
    - ec2SubnetIds (list) --
      
      Unique identifiers for a collection of EC2 subnets.
      - (string) --
    - launchProfileId (string) --
      
      The ID of the launch profile used to control access from the streaming session.
    - launchProfileProtocolVersions (list) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
      - (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - name (string) --
      
      A friendly name for the launch profile.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the launch profile.
    - streamConfiguration (dict) --
      
      A configuration for a streaming session.
      - 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.
      - clipboardMode (string) --
        
        Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
      - ec2InstanceTypes (list) --
        
        The EC2 instance types that users can select from when launching a streaming session with this launch profile.
        
        (string) --
      - maxSessionLengthInMinutes (integer) --
        
        The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
      - maxStoppedSessionLengthInMinutes (integer) --
        
        Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
        
        This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
        
        If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
        
        If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
      - sessionBackup (dict) --
        
        Information about the streaming session backup.
        
        maxBackupsToRetain (integer) --
        
        The maximum number of backups that each streaming session created from this launch profile can have.
        
        mode (string) --
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
      - sessionPersistenceMode (string) --
        
        Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
      - sessionStorage (dict) --
        
        The upload storage for a streaming session.
        
        mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) --
        
        root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded.
      - streamingImageIds (list) --
        
        The streaming images that users can select from when launching a streaming session with this launch profile.
        
        (string) --
      - 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.
    - studioComponentIds (list) --
      
      Unique identifiers for a collection of studio components that can be used with this launch profile.
      - (string) --
    - tags (dict) --
      
      A collection of labels, in the form of key-value pairs, that apply to this resource.
      - (string) --
        
        (string) --
    - 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.
    - validationResults (list) --
      
      The list of the latest validation results.
      - (dict) --
        
        The launch profile validation result.
        
        state (string) --
        
        The current state.
        
        statusCode (string) --
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
        
        statusMessage (string) --
        
        The status message for the validation result.
        
        type (string) --
        
        The type of the validation result.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

ListEulas (new)

Link ¶

List EULAs.

See also: AWS API Documentation

Request Syntax

client.list_eulas(
    eulaIds=[
        'string',
    ],
    nextToken='string'
)

type eulaIds:

list

param eulaIds:

The list of EULA IDs that should be returned

(string) --

type nextToken:

string

param nextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'eulas': [
        {
            'content': 'string',
            'createdAt': datetime(2015, 1, 1),
            'eulaId': 'string',
            'name': 'string',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- eulas (list) --
  
  A collection of EULA resources.
  - (dict) --
    
    Represents a EULA resource.
    - content (string) --
      
      The EULA content.
    - createdAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was created.
    - eulaId (string) --
      
      The EULA ID.
    - name (string) --
      
      The name for the EULA.
    - updatedAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was updated.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

CreateStreamingSessionStream (new)

Link ¶

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

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

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type expirationInSeconds:

integer

param expirationInSeconds:

The expiration time in seconds.

type sessionId:

string

param sessionId:

[REQUIRED]

The streaming 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) --
- 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.

UntagResource (new)

Link ¶

Deletes the tags for a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

Identifies the Amazon Resource Name(ARN) key from which you are removing tags.

type tagKeys:

list

param tagKeys:

[REQUIRED]

One or more tag keys. Specify only the tag keys, not the tag values.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetStudioMember (new)

Link ¶

Get a user's membership in a studio.

See also: AWS API Documentation

Request Syntax

client.get_studio_member(
    principalId='string',
    studioId='string'
)

type principalId:

string

param principalId:

[REQUIRED]

The principal ID. This currently supports a IAM Identity Center UserId.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'member': {
        'identityStoreId': 'string',
        'persona': 'ADMINISTRATOR',
        'principalId': 'string',
        'sid': 'string'
    }
}

Response Structure

(dict) --
- member (dict) --
  
  The member.
  - identityStoreId (string) --
    
    The ID of the identity store.
  - persona (string) --
    
    The persona.
  - principalId (string) --
    
    The principal ID.
  - sid (string) --
    
    The Active Directory Security Identifier for this user, if available.

StopStreamingSession (new)

Link ¶

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.

See also: AWS API Documentation

Request Syntax

client.stop_streaming_session(
    clientToken='string',
    sessionId='string',
    studioId='string',
    volumeRetentionMode='RETAIN'|'DELETE'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type sessionId:

string

param sessionId:

[REQUIRED]

The streaming session ID for the StopStreamingSessionRequest.

type studioId:

string

param studioId:

[REQUIRED]

The studioId for the StopStreamingSessionRequest.

type volumeRetentionMode:

string

param volumeRetentionMode:

Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.

rtype:

dict

returns:

Response Syntax

{
    'session': {
        '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'
    }
}

Response Structure

(dict) --
- session (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.

UpdateStudioComponent (new)

Link ¶

Updates a studio component resource.

See also: AWS API Documentation

Request Syntax

client.update_studio_component(
    clientToken='string',
    configuration={
        'activeDirectoryConfiguration': {
            'computerAttributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'directoryId': 'string',
            'organizationalUnitDistinguishedName': 'string'
        },
        'computeFarmConfiguration': {
            'activeDirectoryUser': 'string',
            'endpoint': 'string'
        },
        'licenseServiceConfiguration': {
            'endpoint': 'string'
        },
        'sharedFileSystemConfiguration': {
            'endpoint': 'string',
            'fileSystemId': 'string',
            'linuxMountPoint': 'string',
            'shareName': 'string',
            'windowsMountDrive': 'string'
        }
    },
    description='string',
    ec2SecurityGroupIds=[
        'string',
    ],
    initializationScripts=[
        {
            'launchProfileProtocolVersion': 'string',
            'platform': 'LINUX'|'WINDOWS',
            'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
            'script': 'string'
        },
    ],
    name='string',
    runtimeRoleArn='string',
    scriptParameters=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    secureInitializationRoleArn='string',
    studioComponentId='string',
    studioId='string',
    subtype='AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
    type='ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type configuration:

dict

param configuration:

The configuration of the studio component, based on component type.

activeDirectoryConfiguration (dict) --

The configuration for a Directory Service for Microsoft Active Directory studio resource.
- computerAttributes (list) --
  
  A collection of custom attributes for an Active Directory computer.
  - (dict) --
    
    An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
    - name (string) --
      
      The name for the LDAP attribute.
    - value (string) --
      
      The value for the LDAP attribute.
- directoryId (string) --
  
  The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
- organizationalUnitDistinguishedName (string) --
  
  The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --

The configuration for a render farm that is associated with a studio resource.
- activeDirectoryUser (string) --
  
  The name of an Active Directory user that is used on ComputeFarm worker instances.
- endpoint (string) --
  
  The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --

The configuration for a license service that is associated with a studio resource.
- endpoint (string) --
  
  The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --

The configuration for a shared file storage system that is associated with a studio resource.
- endpoint (string) --
  
  The endpoint of the shared file system that is accessed by the studio component resource.
- fileSystemId (string) --
  
  The unique identifier for a file system.
- linuxMountPoint (string) --
  
  The mount location for a shared file system on a Linux virtual workstation.
- shareName (string) --
  
  The name of the file share.
- windowsMountDrive (string) --
  
  The mount location for a shared file system on a Windows virtual workstation.

type description:

string

param description:

The description.

type ec2SecurityGroupIds:

list

param ec2SecurityGroupIds:

The EC2 security groups that control access to the studio component.

(string) --

type initializationScripts:

list

param initializationScripts:

Initialization scripts for studio components.

(dict) --

Initialization scripts for studio components.
- launchProfileProtocolVersion (string) --
  
  The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
- platform (string) --
  
  The platform of the initialization script, either Windows or Linux.
- runContext (string) --
  
  The method to use when running the initialization script.
- script (string) --
  
  The initialization script.

type name:

string

param name:

The name for the studio component.

type runtimeRoleArn:

string

param runtimeRoleArn:

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

type scriptParameters:

list

param scriptParameters:

Parameters for the studio component scripts.

(dict) --

A parameter for a studio component script, in the form of a key-value pair.
- key (string) --
  
  A script parameter key.
- value (string) --
  
  A script parameter value.

type secureInitializationRoleArn:

string

param secureInitializationRoleArn:

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

type studioComponentId:

string

param studioComponentId:

[REQUIRED]

The studio component ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

type subtype:

string

param subtype:

The specific subtype of a studio component.

type type:

string

param type:

The type of the studio component.

rtype:

dict

returns:

Response Syntax

{
    'studioComponent': {
        'arn': 'string',
        'configuration': {
            'activeDirectoryConfiguration': {
                'computerAttributes': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'directoryId': 'string',
                'organizationalUnitDistinguishedName': 'string'
            },
            'computeFarmConfiguration': {
                'activeDirectoryUser': 'string',
                'endpoint': 'string'
            },
            'licenseServiceConfiguration': {
                'endpoint': 'string'
            },
            'sharedFileSystemConfiguration': {
                'endpoint': 'string',
                'fileSystemId': 'string',
                'linuxMountPoint': 'string',
                'shareName': 'string',
                'windowsMountDrive': 'string'
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SecurityGroupIds': [
            'string',
        ],
        'initializationScripts': [
            {
                'launchProfileProtocolVersion': 'string',
                'platform': 'LINUX'|'WINDOWS',
                'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                'script': 'string'
            },
        ],
        'name': 'string',
        'runtimeRoleArn': 'string',
        'scriptParameters': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'secureInitializationRoleArn': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
        'statusMessage': 'string',
        'studioComponentId': 'string',
        'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
        'tags': {
            'string': 'string'
        },
        'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- studioComponent (dict) --
  
  Information about the studio component.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - configuration (dict) --
    
    The configuration of the studio component, based on component type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - activeDirectoryConfiguration (dict) --
      
      The configuration for a Directory Service for Microsoft Active Directory studio resource.
      - computerAttributes (list) --
        
        A collection of custom attributes for an Active Directory computer.
        
        (dict) --
        
        An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
        
        name (string) --
        
        The name for the LDAP attribute.
        
        value (string) --
        
        The value for the LDAP attribute.
      - directoryId (string) --
        
        The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
      - organizationalUnitDistinguishedName (string) --
        
        The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
    - computeFarmConfiguration (dict) --
      
      The configuration for a render farm that is associated with a studio resource.
      - activeDirectoryUser (string) --
        
        The name of an Active Directory user that is used on ComputeFarm worker instances.
      - endpoint (string) --
        
        The endpoint of the ComputeFarm that is accessed by the studio component resource.
    - licenseServiceConfiguration (dict) --
      
      The configuration for a license service that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the license service that is accessed by the studio component resource.
    - sharedFileSystemConfiguration (dict) --
      
      The configuration for a shared file storage system that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the shared file system that is accessed by the studio component resource.
      - fileSystemId (string) --
        
        The unique identifier for a file system.
      - linuxMountPoint (string) --
        
        The mount location for a shared file system on a Linux virtual workstation.
      - shareName (string) --
        
        The name of the file share.
      - windowsMountDrive (string) --
        
        The mount location for a shared file system on a Windows virtual workstation.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the studio component.
  - description (string) --
    
    A human-readable description for the studio component resource.
  - ec2SecurityGroupIds (list) --
    
    The EC2 security groups that control access to the studio component.
    - (string) --
  - initializationScripts (list) --
    
    Initialization scripts for studio components.
    - (dict) --
      
      Initialization scripts for studio components.
      - launchProfileProtocolVersion (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
      - platform (string) --
        
        The platform of the initialization script, either Windows or Linux.
      - runContext (string) --
        
        The method to use when running the initialization script.
      - script (string) --
        
        The initialization script.
  - name (string) --
    
    A friendly name for the studio component resource.
  - runtimeRoleArn (string) --
    
    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
  - scriptParameters (list) --
    
    Parameters for the studio component scripts.
    - (dict) --
      
      A parameter for a studio component script, in the form of a key-value pair.
      - key (string) --
        
        A script parameter key.
      - value (string) --
        
        A script parameter value.
  - secureInitializationRoleArn (string) --
    
    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the studio component.
  - studioComponentId (string) --
    
    The unique identifier for a studio component resource.
  - subtype (string) --
    
    The specific subtype of a studio component.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of the studio component.
  - 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.

GetStreamingSessionBackup (new)

Link ¶

Gets StreamingSessionBackup resource.

Invoke this operation to poll for a streaming session backup while stopping a streaming session.

See also: AWS API Documentation

Request Syntax

client.get_streaming_session_backup(
    backupId='string',
    studioId='string'
)

type backupId:

string

param backupId:

[REQUIRED]

The ID of the backup.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'streamingSessionBackup': {
        'arn': 'string',
        'backupId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'launchProfileId': 'string',
        'ownedBy': 'string',
        'sessionId': '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',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- streamingSessionBackup (dict) --
  
  Information about the streaming session backup.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - backupId (string) --
    
    The ID of the backup.
  - createdAt (datetime) --
    
    The ISO timestamp in for when the resource was created.
  - launchProfileId (string) --
    
    The ID of the launch profile which allowed the backups for the streaming session.
  - ownedBy (string) --
    
    The user ID of the user that owns the streaming session.
  - sessionId (string) --
    
    The streaming session ID for the StreamingSessionBackup.
  - state (string) --
    
    The streaming session state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming session backup.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --

TagResource (new)

Link ¶

Creates tags for a resource, given its ARN.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource you want to add tags to.

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

{}

Response Structure

(dict) --

DeleteStudioComponent (new)

Link ¶

Deletes a studio component resource.

See also: AWS API Documentation

Request Syntax

client.delete_studio_component(
    clientToken='string',
    studioComponentId='string',
    studioId='string'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type studioComponentId:

string

param studioComponentId:

[REQUIRED]

The studio component ID.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'studioComponent': {
        'arn': 'string',
        'configuration': {
            'activeDirectoryConfiguration': {
                'computerAttributes': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'directoryId': 'string',
                'organizationalUnitDistinguishedName': 'string'
            },
            'computeFarmConfiguration': {
                'activeDirectoryUser': 'string',
                'endpoint': 'string'
            },
            'licenseServiceConfiguration': {
                'endpoint': 'string'
            },
            'sharedFileSystemConfiguration': {
                'endpoint': 'string',
                'fileSystemId': 'string',
                'linuxMountPoint': 'string',
                'shareName': 'string',
                'windowsMountDrive': 'string'
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SecurityGroupIds': [
            'string',
        ],
        'initializationScripts': [
            {
                'launchProfileProtocolVersion': 'string',
                'platform': 'LINUX'|'WINDOWS',
                'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                'script': 'string'
            },
        ],
        'name': 'string',
        'runtimeRoleArn': 'string',
        'scriptParameters': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'secureInitializationRoleArn': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
        'statusMessage': 'string',
        'studioComponentId': 'string',
        'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
        'tags': {
            'string': 'string'
        },
        'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- studioComponent (dict) --
  
  Information about the studio component.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - configuration (dict) --
    
    The configuration of the studio component, based on component type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - activeDirectoryConfiguration (dict) --
      
      The configuration for a Directory Service for Microsoft Active Directory studio resource.
      - computerAttributes (list) --
        
        A collection of custom attributes for an Active Directory computer.
        
        (dict) --
        
        An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
        
        name (string) --
        
        The name for the LDAP attribute.
        
        value (string) --
        
        The value for the LDAP attribute.
      - directoryId (string) --
        
        The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
      - organizationalUnitDistinguishedName (string) --
        
        The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
    - computeFarmConfiguration (dict) --
      
      The configuration for a render farm that is associated with a studio resource.
      - activeDirectoryUser (string) --
        
        The name of an Active Directory user that is used on ComputeFarm worker instances.
      - endpoint (string) --
        
        The endpoint of the ComputeFarm that is accessed by the studio component resource.
    - licenseServiceConfiguration (dict) --
      
      The configuration for a license service that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the license service that is accessed by the studio component resource.
    - sharedFileSystemConfiguration (dict) --
      
      The configuration for a shared file storage system that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the shared file system that is accessed by the studio component resource.
      - fileSystemId (string) --
        
        The unique identifier for a file system.
      - linuxMountPoint (string) --
        
        The mount location for a shared file system on a Linux virtual workstation.
      - shareName (string) --
        
        The name of the file share.
      - windowsMountDrive (string) --
        
        The mount location for a shared file system on a Windows virtual workstation.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the studio component.
  - description (string) --
    
    A human-readable description for the studio component resource.
  - ec2SecurityGroupIds (list) --
    
    The EC2 security groups that control access to the studio component.
    - (string) --
  - initializationScripts (list) --
    
    Initialization scripts for studio components.
    - (dict) --
      
      Initialization scripts for studio components.
      - launchProfileProtocolVersion (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
      - platform (string) --
        
        The platform of the initialization script, either Windows or Linux.
      - runContext (string) --
        
        The method to use when running the initialization script.
      - script (string) --
        
        The initialization script.
  - name (string) --
    
    A friendly name for the studio component resource.
  - runtimeRoleArn (string) --
    
    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
  - scriptParameters (list) --
    
    Parameters for the studio component scripts.
    - (dict) --
      
      A parameter for a studio component script, in the form of a key-value pair.
      - key (string) --
        
        A script parameter key.
      - value (string) --
        
        A script parameter value.
  - secureInitializationRoleArn (string) --
    
    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the studio component.
  - studioComponentId (string) --
    
    The unique identifier for a studio component resource.
  - subtype (string) --
    
    The specific subtype of a studio component.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of the studio component.
  - 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.

ListStudioMembers (new)

Link ¶

Get all users in a given studio membership.

See also: AWS API Documentation

Request Syntax

client.list_studio_members(
    maxResults=123,
    nextToken='string',
    studioId='string'
)

type maxResults:

integer

param maxResults:

The max number of results to return in the response.

type nextToken:

string

param nextToken:

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

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'members': [
        {
            'identityStoreId': 'string',
            'persona': 'ADMINISTRATOR',
            'principalId': 'string',
            'sid': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- members (list) --
  
  A list of admin members.
  - (dict) --
    
    A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.
    
    When you add a user to your studio using the Nimble Studio console, they are given access to the studio's IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.
    
    When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.
    - identityStoreId (string) --
      
      The ID of the identity store.
    - persona (string) --
      
      The persona.
    - principalId (string) --
      
      The principal ID.
    - sid (string) --
      
      The Active Directory Security Identifier for this user, if available.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

CreateLaunchProfile (new)

Link ¶

Create a launch profile.

See also: AWS API Documentation

Request Syntax

client.create_launch_profile(
    clientToken='string',
    description='string',
    ec2SubnetIds=[
        'string',
    ],
    launchProfileProtocolVersions=[
        'string',
    ],
    name='string',
    streamConfiguration={
        'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
        'clipboardMode': 'ENABLED'|'DISABLED',
        'ec2InstanceTypes': [
            'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
        ],
        'maxSessionLengthInMinutes': 123,
        'maxStoppedSessionLengthInMinutes': 123,
        'sessionBackup': {
            'maxBackupsToRetain': 123,
            'mode': 'AUTOMATIC'|'DEACTIVATED'
        },
        'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
        'sessionStorage': {
            'mode': [
                'UPLOAD',
            ],
            'root': {
                'linux': 'string',
                'windows': 'string'
            }
        },
        'streamingImageIds': [
            'string',
        ],
        'volumeConfiguration': {
            'iops': 123,
            'size': 123,
            'throughput': 123
        }
    },
    studioComponentIds=[
        'string',
    ],
    studioId='string',
    tags={
        'string': 'string'
    }
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type description:

string

param description:

The description.

type ec2SubnetIds:

list

param ec2SubnetIds:

[REQUIRED]

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

(string) --

type launchProfileProtocolVersions:

list

param launchProfileProtocolVersions:

[REQUIRED]

The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

(string) --

The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

type name:

string

param name:

[REQUIRED]

The name for the launch profile.

type streamConfiguration:

dict

param streamConfiguration:

[REQUIRED]

A configuration for a streaming session.

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.
clipboardMode (string) -- [REQUIRED]

Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
ec2InstanceTypes (list) -- [REQUIRED]

The EC2 instance types that users can select from when launching a streaming session with this launch profile.
- (string) --
maxSessionLengthInMinutes (integer) --

The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
maxStoppedSessionLengthInMinutes (integer) --

Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.

If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).

If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
sessionBackup (dict) --

Configures how streaming sessions are backed up when launched from this launch profile.
- maxBackupsToRetain (integer) --
  
  The maximum number of backups that each streaming session created from this launch profile can have.
- mode (string) --
  
  Specifies how artists sessions are backed up.
  
  Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
sessionPersistenceMode (string) --

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
sessionStorage (dict) --

The upload storage for a streaming workstation that is created using this launch profile.
- mode (list) -- [REQUIRED]
  
  Allows artists to upload files to their workstations. The only valid option is UPLOAD.
  - (string) --
- root (dict) --
  
  The configuration for the upload storage root of the streaming session.
  - linux (string) --
    
    The folder path in Linux workstations where files are uploaded.
  - windows (string) --
    
    The folder path in Windows workstations where files are uploaded.
streamingImageIds (list) -- [REQUIRED]

The streaming images that users can select from when launching a streaming session with this launch profile.
- (string) --
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.

type studioComponentIds:

list

param studioComponentIds:

[REQUIRED]

Unique identifiers for a collection of studio components that can be used with this launch profile.

(string) --

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

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
        'statusMessage': 'string',
        'streamConfiguration': {
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionBackup': {
                'maxBackupsToRetain': 123,
                'mode': 'AUTOMATIC'|'DEACTIVATED'
            },
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ],
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            }
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The 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.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - 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.
    - clipboardMode (string) --
      
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
      
      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
    - sessionBackup (dict) --
      
      Information about the streaming session backup.
      - maxBackupsToRetain (integer) --
        
        The maximum number of backups that each streaming session created from this launch profile can have.
      - mode (string) --
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
    - sessionPersistenceMode (string) --
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - sessionStorage (dict) --
      
      The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded.
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - 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.
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - 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.
  - validationResults (list) --
    
    The list of the latest validation results.
    - (dict) --
      
      The launch profile validation result.
      - state (string) --
        
        The current state.
      - statusCode (string) --
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
      - statusMessage (string) --
        
        The status message for the validation result.
      - type (string) --
        
        The type of the validation result.

ListStreamingSessionBackups (new)

Link ¶

Lists the backups of a streaming session in a studio.

See also: AWS API Documentation

Request Syntax

client.list_streaming_session_backups(
    nextToken='string',
    ownedBy='string',
    studioId='string'
)

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

string

param studioId:

[REQUIRED]

The studio ID.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'streamingSessionBackups': [
        {
            'arn': 'string',
            'backupId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'launchProfileId': 'string',
            'ownedBy': 'string',
            'sessionId': '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',
            'tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- streamingSessionBackups (list) --
  
  Information about the streaming session backups.
  - (dict) --
    
    Information about the streaming session backup.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - backupId (string) --
      
      The ID of the backup.
    - createdAt (datetime) --
      
      The ISO timestamp in for when the resource was created.
    - launchProfileId (string) --
      
      The ID of the launch profile which allowed the backups for the streaming session.
    - ownedBy (string) --
      
      The user ID of the user that owns the streaming session.
    - sessionId (string) --
      
      The streaming session ID for the StreamingSessionBackup.
    - state (string) --
      
      The streaming session state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the streaming session backup.
    - tags (dict) --
      
      A collection of labels, in the form of key-value pairs, that apply to this resource.
      - (string) --
        
        (string) --

CreateStudioComponent (new)

Link ¶

Creates a studio component resource.

See also: AWS API Documentation

Request Syntax

client.create_studio_component(
    clientToken='string',
    configuration={
        'activeDirectoryConfiguration': {
            'computerAttributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'directoryId': 'string',
            'organizationalUnitDistinguishedName': 'string'
        },
        'computeFarmConfiguration': {
            'activeDirectoryUser': 'string',
            'endpoint': 'string'
        },
        'licenseServiceConfiguration': {
            'endpoint': 'string'
        },
        'sharedFileSystemConfiguration': {
            'endpoint': 'string',
            'fileSystemId': 'string',
            'linuxMountPoint': 'string',
            'shareName': 'string',
            'windowsMountDrive': 'string'
        }
    },
    description='string',
    ec2SecurityGroupIds=[
        'string',
    ],
    initializationScripts=[
        {
            'launchProfileProtocolVersion': 'string',
            'platform': 'LINUX'|'WINDOWS',
            'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
            'script': 'string'
        },
    ],
    name='string',
    runtimeRoleArn='string',
    scriptParameters=[
        {
            'key': 'string',
            'value': 'string'
        },
    ],
    secureInitializationRoleArn='string',
    studioId='string',
    subtype='AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
    tags={
        'string': 'string'
    },
    type='ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM'
)

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type configuration:

dict

param configuration:

The configuration of the studio component, based on component type.

activeDirectoryConfiguration (dict) --

The configuration for a Directory Service for Microsoft Active Directory studio resource.
- computerAttributes (list) --
  
  A collection of custom attributes for an Active Directory computer.
  - (dict) --
    
    An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
    - name (string) --
      
      The name for the LDAP attribute.
    - value (string) --
      
      The value for the LDAP attribute.
- directoryId (string) --
  
  The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
- organizationalUnitDistinguishedName (string) --
  
  The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --

The configuration for a render farm that is associated with a studio resource.
- activeDirectoryUser (string) --
  
  The name of an Active Directory user that is used on ComputeFarm worker instances.
- endpoint (string) --
  
  The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --

The configuration for a license service that is associated with a studio resource.
- endpoint (string) --
  
  The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --

The configuration for a shared file storage system that is associated with a studio resource.
- endpoint (string) --
  
  The endpoint of the shared file system that is accessed by the studio component resource.
- fileSystemId (string) --
  
  The unique identifier for a file system.
- linuxMountPoint (string) --
  
  The mount location for a shared file system on a Linux virtual workstation.
- shareName (string) --
  
  The name of the file share.
- windowsMountDrive (string) --
  
  The mount location for a shared file system on a Windows virtual workstation.

type description:

string

param description:

The description.

type ec2SecurityGroupIds:

list

param ec2SecurityGroupIds:

The EC2 security groups that control access to the studio component.

(string) --

type initializationScripts:

list

param initializationScripts:

Initialization scripts for studio components.

(dict) --

Initialization scripts for studio components.
- launchProfileProtocolVersion (string) --
  
  The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
- platform (string) --
  
  The platform of the initialization script, either Windows or Linux.
- runContext (string) --
  
  The method to use when running the initialization script.
- script (string) --
  
  The initialization script.

type name:

string

param name:

[REQUIRED]

The name for the studio component.

type runtimeRoleArn:

string

param runtimeRoleArn:

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

type scriptParameters:

list

param scriptParameters:

Parameters for the studio component scripts.

(dict) --

A parameter for a studio component script, in the form of a key-value pair.
- key (string) --
  
  A script parameter key.
- value (string) --
  
  A script parameter value.

type secureInitializationRoleArn:

string

param secureInitializationRoleArn:

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

type subtype:

string

param subtype:

The specific subtype of a studio component.

type tags:

dict

param tags:

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

(string) --
- (string) --

type type:

string

param type:

[REQUIRED]

The type of the studio component.

rtype:

dict

returns:

Response Syntax

{
    'studioComponent': {
        'arn': 'string',
        'configuration': {
            'activeDirectoryConfiguration': {
                'computerAttributes': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'directoryId': 'string',
                'organizationalUnitDistinguishedName': 'string'
            },
            'computeFarmConfiguration': {
                'activeDirectoryUser': 'string',
                'endpoint': 'string'
            },
            'licenseServiceConfiguration': {
                'endpoint': 'string'
            },
            'sharedFileSystemConfiguration': {
                'endpoint': 'string',
                'fileSystemId': 'string',
                'linuxMountPoint': 'string',
                'shareName': 'string',
                'windowsMountDrive': 'string'
            }
        },
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SecurityGroupIds': [
            'string',
        ],
        'initializationScripts': [
            {
                'launchProfileProtocolVersion': 'string',
                'platform': 'LINUX'|'WINDOWS',
                'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                'script': 'string'
            },
        ],
        'name': 'string',
        'runtimeRoleArn': 'string',
        'scriptParameters': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'secureInitializationRoleArn': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
        'statusMessage': 'string',
        'studioComponentId': 'string',
        'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
        'tags': {
            'string': 'string'
        },
        'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- studioComponent (dict) --
  
  Information about the studio component.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - configuration (dict) --
    
    The configuration of the studio component, based on component type.
    Note
    
    This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
    - activeDirectoryConfiguration (dict) --
      
      The configuration for a Directory Service for Microsoft Active Directory studio resource.
      - computerAttributes (list) --
        
        A collection of custom attributes for an Active Directory computer.
        
        (dict) --
        
        An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
        
        name (string) --
        
        The name for the LDAP attribute.
        
        value (string) --
        
        The value for the LDAP attribute.
      - directoryId (string) --
        
        The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
      - organizationalUnitDistinguishedName (string) --
        
        The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
    - computeFarmConfiguration (dict) --
      
      The configuration for a render farm that is associated with a studio resource.
      - activeDirectoryUser (string) --
        
        The name of an Active Directory user that is used on ComputeFarm worker instances.
      - endpoint (string) --
        
        The endpoint of the ComputeFarm that is accessed by the studio component resource.
    - licenseServiceConfiguration (dict) --
      
      The configuration for a license service that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the license service that is accessed by the studio component resource.
    - sharedFileSystemConfiguration (dict) --
      
      The configuration for a shared file storage system that is associated with a studio resource.
      - endpoint (string) --
        
        The endpoint of the shared file system that is accessed by the studio component resource.
      - fileSystemId (string) --
        
        The unique identifier for a file system.
      - linuxMountPoint (string) --
        
        The mount location for a shared file system on a Linux virtual workstation.
      - shareName (string) --
        
        The name of the file share.
      - windowsMountDrive (string) --
        
        The mount location for a shared file system on a Windows virtual workstation.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the studio component.
  - description (string) --
    
    A human-readable description for the studio component resource.
  - ec2SecurityGroupIds (list) --
    
    The EC2 security groups that control access to the studio component.
    - (string) --
  - initializationScripts (list) --
    
    Initialization scripts for studio components.
    - (dict) --
      
      Initialization scripts for studio components.
      - launchProfileProtocolVersion (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
      - platform (string) --
        
        The platform of the initialization script, either Windows or Linux.
      - runContext (string) --
        
        The method to use when running the initialization script.
      - script (string) --
        
        The initialization script.
  - name (string) --
    
    A friendly name for the studio component resource.
  - runtimeRoleArn (string) --
    
    An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
  - scriptParameters (list) --
    
    Parameters for the studio component scripts.
    - (dict) --
      
      A parameter for a studio component script, in the form of a key-value pair.
      - key (string) --
        
        A script parameter key.
      - value (string) --
        
        A script parameter value.
  - secureInitializationRoleArn (string) --
    
    An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the studio component.
  - studioComponentId (string) --
    
    The unique identifier for a studio component resource.
  - subtype (string) --
    
    The specific subtype of a studio component.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - type (string) --
    
    The type of the studio component.
  - 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.

ListStudioComponents (new)

Link ¶

Lists the StudioComponents in a studio.

See also: AWS API Documentation

Request Syntax

client.list_studio_components(
    maxResults=123,
    nextToken='string',
    states=[
        'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
    ],
    studioId='string',
    types=[
        'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
    ]
)

type maxResults:

integer

param maxResults:

The max number of results to return in the response.

type nextToken:

string

param nextToken:

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

type states:

list

param states:

Filters the request to studio components that are in one of the given states.

(string) --

The current state of the studio component resource.

While a studio component is being created, modified, or deleted, its state will be CREATE_IN_PROGRESS, UPDATE_IN_PROGRESS, or DELETE_IN_PROGRESS.

These are called transition states.

No modifications may be made to the studio component while it is in a transition state.

If creation of the resource fails, the state will change to CREATE_FAILED. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.

If updating the resource fails, the state will change to UPDATE_FAILED. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.

If deleting the resource fails, the state will change to DELETE_FAILED. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the DELETED state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

type types:

list

param types:

Filters the request to studio components that are of one of the given types.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'studioComponents': [
        {
            'arn': 'string',
            'configuration': {
                'activeDirectoryConfiguration': {
                    'computerAttributes': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'directoryId': 'string',
                    'organizationalUnitDistinguishedName': 'string'
                },
                'computeFarmConfiguration': {
                    'activeDirectoryUser': 'string',
                    'endpoint': 'string'
                },
                'licenseServiceConfiguration': {
                    'endpoint': 'string'
                },
                'sharedFileSystemConfiguration': {
                    'endpoint': 'string',
                    'fileSystemId': 'string',
                    'linuxMountPoint': 'string',
                    'shareName': 'string',
                    'windowsMountDrive': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'ec2SecurityGroupIds': [
                'string',
            ],
            'initializationScripts': [
                {
                    'launchProfileProtocolVersion': 'string',
                    'platform': 'LINUX'|'WINDOWS',
                    'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                    'script': 'string'
                },
            ],
            'name': 'string',
            'runtimeRoleArn': 'string',
            'scriptParameters': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'secureInitializationRoleArn': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
            'statusMessage': 'string',
            'studioComponentId': 'string',
            'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
            'tags': {
                'string': 'string'
            },
            'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- studioComponents (list) --
  
  A collection of studio components.
  - (dict) --
    
    A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.
    
    Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.
    
    A studio component also has a set of initialization scripts that are returned by GetLaunchProfileInitialization. These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.
    - arn (string) --
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - configuration (dict) --
      
      The configuration of the studio component, based on component type.
      Note
      
      This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - activeDirectoryConfiguration (dict) --
        
        The configuration for a Directory Service for Microsoft Active Directory studio resource.
        
        computerAttributes (list) --
        
        A collection of custom attributes for an Active Directory computer.
        
        (dict) --
        
        An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
        
        name (string) --
        
        The name for the LDAP attribute.
        
        value (string) --
        
        The value for the LDAP attribute.
        
        directoryId (string) --
        
        The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
        
        organizationalUnitDistinguishedName (string) --
        
        The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
      - computeFarmConfiguration (dict) --
        
        The configuration for a render farm that is associated with a studio resource.
        
        activeDirectoryUser (string) --
        
        The name of an Active Directory user that is used on ComputeFarm worker instances.
        
        endpoint (string) --
        
        The endpoint of the ComputeFarm that is accessed by the studio component resource.
      - licenseServiceConfiguration (dict) --
        
        The configuration for a license service that is associated with a studio resource.
        
        endpoint (string) --
        
        The endpoint of the license service that is accessed by the studio component resource.
      - sharedFileSystemConfiguration (dict) --
        
        The configuration for a shared file storage system that is associated with a studio resource.
        
        endpoint (string) --
        
        The endpoint of the shared file system that is accessed by the studio component resource.
        
        fileSystemId (string) --
        
        The unique identifier for a file system.
        
        linuxMountPoint (string) --
        
        The mount location for a shared file system on a Linux virtual workstation.
        
        shareName (string) --
        
        The name of the file share.
        
        windowsMountDrive (string) --
        
        The mount location for a shared file system on a Windows virtual workstation.
    - createdAt (datetime) --
      
      The ISO timestamp in seconds for when the resource was created.
    - createdBy (string) --
      
      The user ID of the user that created the studio component.
    - description (string) --
      
      A human-readable description for the studio component resource.
    - ec2SecurityGroupIds (list) --
      
      The EC2 security groups that control access to the studio component.
      - (string) --
    - initializationScripts (list) --
      
      Initialization scripts for studio components.
      - (dict) --
        
        Initialization scripts for studio components.
        
        launchProfileProtocolVersion (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
        
        platform (string) --
        
        The platform of the initialization script, either Windows or Linux.
        
        runContext (string) --
        
        The method to use when running the initialization script.
        
        script (string) --
        
        The initialization script.
    - name (string) --
      
      A friendly name for the studio component resource.
    - runtimeRoleArn (string) --
      
      An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.
    - scriptParameters (list) --
      
      Parameters for the studio component scripts.
      - (dict) --
        
        A parameter for a studio component script, in the form of a key-value pair.
        
        key (string) --
        
        A script parameter key.
        
        value (string) --
        
        A script parameter value.
    - secureInitializationRoleArn (string) --
      
      An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the studio component.
    - studioComponentId (string) --
      
      The unique identifier for a studio component resource.
    - subtype (string) --
      
      The specific subtype of a studio component.
    - tags (dict) --
      
      A collection of labels, in the form of key-value pairs, that apply to this resource.
      - (string) --
        
        (string) --
    - type (string) --
      
      The type of the studio component.
    - 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.

CreateStreamingSession (new)

Link ¶

Creates a streaming session in a studio.

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

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'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
    launchProfileId='string',
    ownedBy='string',
    streamingImageId='string',
    studioId='string',
    tags={
        'string': 'string'
    }
)

type clientToken:

string

param clientToken:

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:

[REQUIRED]

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

type ownedBy:

string

param ownedBy:

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.

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',
        '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'
    }
}

Response Structure

(dict) --
- session (dict) --
  
  The session.
  - 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.

UpdateStudio (new)

Link ¶

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

See also: AWS API Documentation

Request Syntax

client.update_studio(
    adminRoleArn='string',
    clientToken='string',
    displayName='string',
    studioId='string',
    userRoleArn='string'
)

type adminRoleArn:

string

param adminRoleArn:

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

type clientToken:

string

param clientToken:

This field is autopopulated if not provided.

type displayName:

string

param displayName:

A friendly name for the studio.

type studioId:

string

param studioId:

[REQUIRED]

The studio ID.

type userRoleArn:

string

param userRoleArn:

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

rtype:

dict

returns:

Response Syntax

{
    'studio': {
        'adminRoleArn': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'displayName': 'string',
        'homeRegion': 'string',
        'ssoClientId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'STUDIO_CREATED'|'STUDIO_DELETED'|'STUDIO_UPDATED'|'STUDIO_CREATE_IN_PROGRESS'|'STUDIO_UPDATE_IN_PROGRESS'|'STUDIO_DELETE_IN_PROGRESS'|'STUDIO_WITH_LAUNCH_PROFILES_NOT_DELETED'|'STUDIO_WITH_STUDIO_COMPONENTS_NOT_DELETED'|'STUDIO_WITH_STREAMING_IMAGES_NOT_DELETED'|'AWS_SSO_NOT_ENABLED'|'AWS_SSO_ACCESS_DENIED'|'ROLE_NOT_OWNED_BY_STUDIO_OWNER'|'ROLE_COULD_NOT_BE_ASSUMED'|'INTERNAL_ERROR'|'ENCRYPTION_KEY_NOT_FOUND'|'ENCRYPTION_KEY_ACCESS_DENIED'|'AWS_SSO_CONFIGURATION_REPAIRED'|'AWS_SSO_CONFIGURATION_REPAIR_IN_PROGRESS'|'AWS_STS_REGION_DISABLED',
        'statusMessage': 'string',
        'studioEncryptionConfiguration': {
            'keyArn': 'string',
            'keyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'studioId': 'string',
        'studioName': 'string',
        'studioUrl': 'string',
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'userRoleArn': 'string'
    }
}

Response Structure

(dict) --
- studio (dict) --
  
  Information about a studio.
  - adminRoleArn (string) --
    
    The IAM role that studio admins assume when logging in to the Nimble Studio portal.
  - arn (string) --
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - createdAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was created.
  - displayName (string) --
    
    A friendly name for the studio.
  - homeRegion (string) --
    
    The Amazon Web Services Region where the studio resource is located.
  - ssoClientId (string) --
    
    The IAM Identity Center application client ID used to integrate with IAM Identity Center. This ID allows IAM Identity Center users to log in to Nimble Studio portal.
  - state (string) --
    
    The current state of the studio resource.
  - statusCode (string) --
    
    Status codes that provide additional detail on the studio state.
  - statusMessage (string) --
    
    Additional detail on the studio state.
  - studioEncryptionConfiguration (dict) --
    
    Configuration of the encryption method that is used for the studio.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - studioId (string) --
    
    The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
  - studioName (string) --
    
    The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
  - studioUrl (string) --
    
    The address of the web page for the studio.
  - tags (dict) --
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The ISO timestamp in seconds for when the resource was updated.
  - userRoleArn (string) --
    
    The IAM role that studio users assume when logging in to the Nimble Studio portal.