2022/12/20 - AmazonNimbleStudio - 2 new18 updated api methods
Changes Amazon Nimble Studio now supports configuring session storage volumes and persistence, as well as backup and restore sessions through launch profiles.
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'
)
string
The token for the next set of results, or null if there are no more results.
string
The user ID of the user that owns the streaming session.
string
[REQUIRED]
The studio ID.
dict
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) --
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'
)
string
[REQUIRED]
The ID of the backup.
string
[REQUIRED]
The studio ID.
dict
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) --
{'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC | DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}
Response {'launchProfile': {'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC '
'| '
'DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}}
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'
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
The description.
list
[REQUIRED]
Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.
(string) --
list
[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".
string
[REQUIRED]
The name for the launch profile.
dict
[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.
list
[REQUIRED]
Unique identifiers for a collection of studio components that can be used with this launch profile.
(string) --
string
[REQUIRED]
The studio ID.
dict
A collection of labels, in the form of key-value pairs, that apply to this resource.
(string) --
(string) --
dict
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.
{'session': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'backupMode': 'AUTOMATIC | DEACTIVATED',
'maxBackupsToRetain': 'integer',
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'startedFromBackupId': 'string',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'},
'volumeRetentionMode': 'RETAIN | DELETE'}}
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'
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
The EC2 Instance type used for the streaming session.
string
[REQUIRED]
The ID of the launch profile used to control access from the streaming session.
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.
string
The ID of the streaming image.
string
[REQUIRED]
The studio ID.
dict
A collection of labels, in the form of key-value pairs, that apply to this resource.
(string) --
(string) --
dict
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.
{'studio': {'statusCode': {'AWS_STS_REGION_DISABLED'}}}
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'
)
string
[REQUIRED]
The IAM role that studio admins will assume when logging in to the Nimble Studio portal.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
A friendly name for the studio.
dict
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.
string
[REQUIRED]
The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
dict
A collection of labels, in the form of key-value pairs, that apply to this resource.
(string) --
(string) --
string
[REQUIRED]
The IAM role that studio users will assume when logging in to the Nimble Studio portal.
dict
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.
{'launchProfile': {'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC '
'| '
'DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}}
Permanently delete a launch profile.
See also: AWS API Documentation
Request Syntax
client.delete_launch_profile(
clientToken='string',
launchProfileId='string',
studioId='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The ID of the launch profile used to control access from the streaming session.
string
[REQUIRED]
The studio ID.
dict
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.
{'session': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'backupMode': 'AUTOMATIC | DEACTIVATED',
'maxBackupsToRetain': 'integer',
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'startedFromBackupId': 'string',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'},
'volumeRetentionMode': 'RETAIN | DELETE'}}
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'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The streaming session ID.
string
[REQUIRED]
The studio ID.
dict
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.
{'studio': {'statusCode': {'AWS_STS_REGION_DISABLED'}}}
Delete a studio resource.
See also: AWS API Documentation
Request Syntax
client.delete_studio(
clientToken='string',
studioId='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The studio ID.
dict
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.
{'launchProfile': {'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC '
'| '
'DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}}
Get a launch profile.
See also: AWS API Documentation
Request Syntax
client.get_launch_profile(
launchProfileId='string',
studioId='string'
)
string
[REQUIRED]
The ID of the launch profile used to control access from the streaming session.
string
[REQUIRED]
The studio ID.
dict
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.
{'launchProfile': {'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC '
'| '
'DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}}
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'
)
string
[REQUIRED]
The ID of the launch profile used to control access from the streaming session.
string
[REQUIRED]
The studio ID.
dict
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.
{'session': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'backupMode': 'AUTOMATIC | DEACTIVATED',
'maxBackupsToRetain': 'integer',
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'startedFromBackupId': 'string',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'},
'volumeRetentionMode': 'RETAIN | DELETE'}}
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'
)
string
[REQUIRED]
The streaming session ID.
string
[REQUIRED]
The studio ID.
dict
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.
{'studio': {'statusCode': {'AWS_STS_REGION_DISABLED'}}}
Get a studio resource.
See also: AWS API Documentation
Request Syntax
client.get_studio(
studioId='string'
)
string
[REQUIRED]
The studio ID.
dict
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.
{'launchProfiles': {'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC '
'| '
'DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}}
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'
)
integer
The max number of results to return in the response.
string
The token for the next set of results, or null if there are no more results.
string
The principal ID. This currently supports a IAM Identity Center UserId.
list
Filter this request to launch profiles in any of the given states.
(string) --
string
[REQUIRED]
The studio ID.
dict
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.
{'sessions': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'backupMode': 'AUTOMATIC | DEACTIVATED',
'maxBackupsToRetain': 'integer',
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'startedFromBackupId': 'string',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'},
'volumeRetentionMode': 'RETAIN | DELETE'}}
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'
)
string
Filters the request to streaming sessions created by the given user.
string
The token for the next set of results, or null if there are no more results.
string
Filters the request to streaming session owned by the given user
string
Filters the request to only the provided session IDs.
string
[REQUIRED]
The studio ID.
dict
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.
{'studios': {'statusCode': {'AWS_STS_REGION_DISABLED'}}}
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'
)
string
The token for the next set of results, or null if there are no more results.
dict
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.
{'backupId': 'string'}
Response {'session': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'backupMode': 'AUTOMATIC | DEACTIVATED',
'maxBackupsToRetain': 'integer',
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'startedFromBackupId': 'string',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'},
'volumeRetentionMode': 'RETAIN | DELETE'}}
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'
)
string
The ID of the backup.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The streaming session ID for the StartStreamingSessionRequest.
string
[REQUIRED]
The studio ID for the StartStreamingSessionRequest.
dict
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.
{'studio': {'statusCode': {'AWS_STS_REGION_DISABLED'}}}
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'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The studio ID.
dict
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.
{'volumeRetentionMode': 'RETAIN | DELETE'}
Response {'session': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'backupMode': 'AUTOMATIC | DEACTIVATED',
'maxBackupsToRetain': 'integer',
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'startedFromBackupId': 'string',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'},
'volumeRetentionMode': 'RETAIN | DELETE'}}
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'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The streaming session ID for the StopStreamingSessionRequest.
string
[REQUIRED]
The studioId for the StopStreamingSessionRequest.
string
Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.
dict
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.
{'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED | ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC | DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED | ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}
Response {'launchProfile': {'streamConfiguration': {'automaticTerminationMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'sessionBackup': {'maxBackupsToRetain': 'integer',
'mode': 'AUTOMATIC '
'| '
'DEACTIVATED'},
'sessionPersistenceMode': 'DEACTIVATED '
'| '
'ACTIVATED',
'volumeConfiguration': {'iops': 'integer',
'size': 'integer',
'throughput': 'integer'}}}}
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'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
The description.
string
[REQUIRED]
The ID of the launch profile used to control access from the streaming session.
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".
string
The name for the launch profile.
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) -- [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.
list
Unique identifiers for a collection of studio components that can be used with this launch profile.
(string) --
string
[REQUIRED]
The studio ID.
dict
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.
{'studio': {'statusCode': {'AWS_STS_REGION_DISABLED'}}}
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'
)
string
The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
This field is autopopulated if not provided.
string
A friendly name for the studio.
string
[REQUIRED]
The studio ID.
string
The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
dict
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.