2021/11/02 - AmazonNimbleStudio - 2 new15 updated api methods
Changes Amazon Nimble Studio adds support for users to stop and start streaming sessions.
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'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS 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.
dict
Response Syntax
{
'session': {
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'ec2InstanceType': 'string',
'launchProfileId': 'string',
'ownedBy': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'startedBy': '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',
'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'
}
}
Response Structure
(dict) --
session (dict) --
A streaming session is a virtual workstation created using a particular launch profile.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session.
ec2InstanceType (string) --
The EC2 Instance type used for the streaming session.
launchProfileId (string) --
The ID of the launch profile used to control access from the streaming session.
ownedBy (string) --
The user ID of the user that owns the streaming session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The time the session entered START_IN_PROGRESS state.
startedBy (string) --
The user ID of the user that started the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
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(
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 AWS 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',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'ec2InstanceType': 'string',
'launchProfileId': 'string',
'ownedBy': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'startedBy': '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',
'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'
}
}
Response Structure
(dict) --
session (dict) --
A streaming session is a virtual workstation created using a particular launch profile.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session.
ec2InstanceType (string) --
The EC2 Instance type used for the streaming session.
launchProfileId (string) --
The ID of the launch profile used to control access from the streaming session.
ownedBy (string) --
The user ID of the user that owns the streaming session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The time the session entered START_IN_PROGRESS state.
startedBy (string) --
The user ID of the user that started the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'streamConfiguration': {'maxStoppedSessionLengthInMinutes': 'integer'}}
Response {'launchProfile': {'streamConfiguration': {'maxStoppedSessionLengthInMinutes': '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={
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
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 AWS 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.
clipboardMode (string) -- [REQUIRED]
Enable or disable 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) --
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.
streamingImageIds (list) -- [REQUIRED]
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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',
'statusMessage': 'string',
'streamConfiguration': {
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
'studioComponentIds': [
'string',
],
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
launchProfile (dict) --
The launch profile.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 launch profile ID.
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.
clipboardMode (string) --
Enable or disable 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.
If the value is missing or 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 by AWS (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 by AWS (instead of terminated).
streamingImageIds (list) --
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'session': {'startedAt': 'timestamp',
'startedBy': 'string',
'state': {'START_FAILED',
'START_IN_PROGRESS',
'STOPPED',
'STOP_FAILED',
'STOP_IN_PROGRESS'},
'statusCode': {'STREAMING_SESSION_STARTED',
'STREAMING_SESSION_START_IN_PROGRESS',
'STREAMING_SESSION_STOPPED',
'STREAMING_SESSION_STOP_IN_PROGRESS'},
'stopAt': 'timestamp',
'stoppedAt': 'timestamp',
'stoppedBy': 'string'}}
Creates a streaming session in a studio.
After invoking this operation, you must poll GetStreamingSession until the streaming session is in state READY.
See also: AWS API Documentation
Request Syntax
client.create_streaming_session(
clientToken='string',
ec2InstanceType='g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
launchProfileId='string',
ownedBy='string',
streamingImageId='string',
studioId='string',
tags={
'string': 'string'
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS 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
The launch profile ID.
string
The user ID of the user that owns the streaming session.
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',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'ec2InstanceType': 'string',
'launchProfileId': 'string',
'ownedBy': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'startedBy': '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',
'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'
}
}
Response Structure
(dict) --
session (dict) --
The session.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session.
ec2InstanceType (string) --
The EC2 Instance type used for the streaming session.
launchProfileId (string) --
The ID of the launch profile used to control access from the streaming session.
ownedBy (string) --
The user ID of the user that owns the streaming session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The time the session entered START_IN_PROGRESS state.
startedBy (string) --
The user ID of the user that started the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'launchProfile': {'streamConfiguration': {'maxStoppedSessionLengthInMinutes': '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 AWS 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 Launch Profile ID.
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',
'statusMessage': 'string',
'streamConfiguration': {
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
'studioComponentIds': [
'string',
],
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
launchProfile (dict) --
The launch profile.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 launch profile ID.
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.
clipboardMode (string) --
Enable or disable 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.
If the value is missing or 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 by AWS (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 by AWS (instead of terminated).
streamingImageIds (list) --
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'session': {'startedAt': 'timestamp',
'startedBy': 'string',
'state': {'START_FAILED',
'START_IN_PROGRESS',
'STOPPED',
'STOP_FAILED',
'STOP_IN_PROGRESS'},
'statusCode': {'STREAMING_SESSION_STARTED',
'STREAMING_SESSION_START_IN_PROGRESS',
'STREAMING_SESSION_STOPPED',
'STREAMING_SESSION_STOP_IN_PROGRESS'},
'stopAt': 'timestamp',
'stoppedAt': 'timestamp',
'stoppedBy': 'string'}}
Deletes streaming session resource.
After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.
A streaming session will count against your streaming session quota until it is marked DELETED.
See also: AWS API Documentation
Request Syntax
client.delete_streaming_session(
clientToken='string',
sessionId='string',
studioId='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS 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',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'ec2InstanceType': 'string',
'launchProfileId': 'string',
'ownedBy': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'startedBy': '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',
'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'
}
}
Response Structure
(dict) --
session (dict) --
The session.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session.
ec2InstanceType (string) --
The EC2 Instance type used for the streaming session.
launchProfileId (string) --
The ID of the launch profile used to control access from the streaming session.
ownedBy (string) --
The user ID of the user that owns the streaming session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The time the session entered START_IN_PROGRESS state.
startedBy (string) --
The user ID of the user that started the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'launchProfile': {'streamConfiguration': {'maxStoppedSessionLengthInMinutes': 'integer'}}}
Get a launch profile.
See also: AWS API Documentation
Request Syntax
client.get_launch_profile(
launchProfileId='string',
studioId='string'
)
string
[REQUIRED]
The Launch Profile ID.
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',
'statusMessage': 'string',
'streamConfiguration': {
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
'studioComponentIds': [
'string',
],
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
launchProfile (dict) --
The launch profile.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 launch profile ID.
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.
clipboardMode (string) --
Enable or disable 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.
If the value is missing or 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 by AWS (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 by AWS (instead of terminated).
streamingImageIds (list) --
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'launchProfile': {'streamConfiguration': {'maxStoppedSessionLengthInMinutes': '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 Launch Profile ID.
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',
'statusMessage': 'string',
'streamConfiguration': {
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
'studioComponentIds': [
'string',
],
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
'streamingImages': [
{
'arn': 'string',
'description': 'string',
'ec2ImageId': 'string',
'encryptionConfiguration': {
'keyArn': 'string',
'keyType': 'CUSTOMER_MANAGED_KEY'
},
'eulaIds': [
'string',
],
'name': 'string',
'owner': 'string',
'platform': 'string',
'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR',
'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 ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 launch profile ID.
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.
clipboardMode (string) --
Enable or disable 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.
If the value is missing or 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 by AWS (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 by AWS (instead of terminated).
streamingImageIds (list) --
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
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 Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.
arn (string) --
The ARN of the resource.
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) --
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'member': {'sid': 'string'}}
Get a user persona in launch profile membership.
See also: AWS API Documentation
Request Syntax
client.get_launch_profile_member(
launchProfileId='string',
principalId='string',
studioId='string'
)
string
[REQUIRED]
The Launch Profile ID.
string
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
string
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'member': {
'identityStoreId': 'string',
'persona': 'USER',
'principalId': 'string',
'sid': 'string'
}
}
Response Structure
(dict) --
member (dict) --
The member.
identityStoreId (string) --
The ID of the identity store.
persona (string) --
The persona.
principalId (string) --
The principal ID.
sid (string) --
The Active Directory Security Identifier for this user, if available.
{'session': {'startedAt': 'timestamp',
'startedBy': 'string',
'state': {'START_FAILED',
'START_IN_PROGRESS',
'STOPPED',
'STOP_FAILED',
'STOP_IN_PROGRESS'},
'statusCode': {'STREAMING_SESSION_STARTED',
'STREAMING_SESSION_START_IN_PROGRESS',
'STREAMING_SESSION_STOPPED',
'STREAMING_SESSION_STOP_IN_PROGRESS'},
'stopAt': 'timestamp',
'stoppedAt': 'timestamp',
'stoppedBy': 'string'}}
Gets StreamingSession resource.
anvoke 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',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'ec2InstanceType': 'string',
'launchProfileId': 'string',
'ownedBy': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'startedBy': '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',
'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'
}
}
Response Structure
(dict) --
session (dict) --
The session.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session.
ec2InstanceType (string) --
The EC2 Instance type used for the streaming session.
launchProfileId (string) --
The ID of the launch profile used to control access from the streaming session.
ownedBy (string) --
The user ID of the user that owns the streaming session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The time the session entered START_IN_PROGRESS state.
startedBy (string) --
The user ID of the user that started the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'member': {'sid': 'string'}}
Get a user's membership in a studio.
See also: AWS API Documentation
Request Syntax
client.get_studio_member(
principalId='string',
studioId='string'
)
string
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
string
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'member': {
'identityStoreId': 'string',
'persona': 'ADMINISTRATOR',
'principalId': 'string',
'sid': 'string'
}
}
Response Structure
(dict) --
member (dict) --
The member.
identityStoreId (string) --
The ID of the identity store.
persona (string) --
The persona.
principalId (string) --
The principal ID.
sid (string) --
The Active Directory Security Identifier for this user, if available.
{'members': {'sid': 'string'}}
Get all users in a given launch profile membership.
See also: AWS API Documentation
Request Syntax
client.list_launch_profile_members(
launchProfileId='string',
maxResults=123,
nextToken='string',
studioId='string'
)
string
[REQUIRED]
The Launch Profile ID.
integer
The max number of results to return in the response.
string
The token to request the next page of results.
string
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'members': [
{
'identityStoreId': 'string',
'persona': 'USER',
'principalId': 'string',
'sid': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
members (list) --
A list of members.
(dict) --
identityStoreId (string) --
The ID of the identity store.
persona (string) --
The persona.
principalId (string) --
The principal ID.
sid (string) --
The Active Directory Security Identifier for this user, if available.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
{'launchProfiles': {'streamConfiguration': {'maxStoppedSessionLengthInMinutes': '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=[
'string',
],
studioId='string'
)
integer
The max number of results to return in the response.
string
The token to request the next page of results.
string
The principal ID. This currently supports a Amazon Web Services SSO 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',
'statusMessage': 'string',
'streamConfiguration': {
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
'studioComponentIds': [
'string',
],
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
],
'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).
`` <p>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.</p>``
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 launch profile ID.
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.
clipboardMode (string) --
Enable or disable 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.
If the value is missing or 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 by AWS (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 by AWS (instead of terminated).
streamingImageIds (list) --
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
{'sessions': {'startedAt': 'timestamp',
'startedBy': 'string',
'state': {'START_FAILED',
'START_IN_PROGRESS',
'STOPPED',
'STOP_FAILED',
'STOP_IN_PROGRESS'},
'statusCode': {'STREAMING_SESSION_STARTED',
'STREAMING_SESSION_START_IN_PROGRESS',
'STREAMING_SESSION_STOPPED',
'STREAMING_SESSION_STOP_IN_PROGRESS'},
'stopAt': 'timestamp',
'stoppedAt': 'timestamp',
'stoppedBy': 'string'}}
Lists the streaming image resources in a studio.
See also: AWS API Documentation
Request Syntax
client.list_streaming_sessions(
createdBy='string',
nextToken='string',
ownedBy='string',
sessionIds='string',
studioId='string'
)
string
Filters the request to streaming sessions created by the given user.
string
The token to request the next page of 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',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'ec2InstanceType': 'string',
'launchProfileId': 'string',
'ownedBy': 'string',
'sessionId': 'string',
'startedAt': datetime(2015, 1, 1),
'startedBy': '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',
'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'
},
]
}
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 ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session.
ec2InstanceType (string) --
The EC2 Instance type used for the streaming session.
launchProfileId (string) --
The ID of the launch profile used to control access from the streaming session.
ownedBy (string) --
The user ID of the user that owns the streaming session.
sessionId (string) --
The session ID.
startedAt (datetime) --
The time the session entered START_IN_PROGRESS state.
startedBy (string) --
The user ID of the user that started the 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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'members': {'sid': 'string'}}
Get all users in a given studio membership.
See also: AWS API Documentation
Request Syntax
client.list_studio_members(
maxResults=123,
nextToken='string',
studioId='string'
)
integer
The max number of results to return in the response.
string
The token to request the next page of results.
string
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'members': [
{
'identityStoreId': 'string',
'persona': 'ADMINISTRATOR',
'principalId': 'string',
'sid': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
members (list) --
A list of members.
(dict) --
A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.
When you add a user to your studio using the Nimble Studio console, they are given access to the studio's AWS SSO application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio's user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.
When you add a user to studio membership with the persona ADMIN, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio's Admin IAM role.
identityStoreId (string) --
The ID of the identity store.
persona (string) --
The persona.
principalId (string) --
The principal ID.
sid (string) --
The Active Directory Security Identifier for this user, if available.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
{'streamConfiguration': {'maxStoppedSessionLengthInMinutes': 'integer'}}
Response {'launchProfile': {'streamConfiguration': {'maxStoppedSessionLengthInMinutes': '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={
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
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 AWS 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 Launch Profile ID.
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.
clipboardMode (string) -- [REQUIRED]
Enable or disable 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) --
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.
streamingImageIds (list) -- [REQUIRED]
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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',
'statusMessage': 'string',
'streamConfiguration': {
'clipboardMode': 'ENABLED'|'DISABLED',
'ec2InstanceTypes': [
'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
],
'maxSessionLengthInMinutes': 123,
'maxStoppedSessionLengthInMinutes': 123,
'streamingImageIds': [
'string',
]
},
'studioComponentIds': [
'string',
],
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
launchProfile (dict) --
The launch profile.
arn (string) --
The ARN of the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the 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 launch profile ID.
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.
clipboardMode (string) --
Enable or disable 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.
If the value is missing or 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 by AWS (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 by AWS (instead of terminated).
streamingImageIds (list) --
The streaming images that users can select from when launching a streaming session with this launch profile.
(string) --
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 Unix epoch timestamp in seconds for when the resource was updated.
updatedBy (string) --
The user ID of the user that most recently updated the resource.
{'member': {'sid': 'string'}}
Update a user persona in launch profile membership.
See also: AWS API Documentation
Request Syntax
client.update_launch_profile_member(
clientToken='string',
launchProfileId='string',
persona='USER',
principalId='string',
studioId='string'
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS 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 Launch Profile ID.
string
[REQUIRED]
The persona.
string
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
string
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'member': {
'identityStoreId': 'string',
'persona': 'USER',
'principalId': 'string',
'sid': 'string'
}
}
Response Structure
(dict) --
member (dict) --
The updated member.
identityStoreId (string) --
The ID of the identity store.
persona (string) --
The persona.
principalId (string) --
The principal ID.
sid (string) --
The Active Directory Security Identifier for this user, if available.