Table of Contents
A low-level client representing AmazonNimbleStudio
Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.
Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.
import boto3
client = boto3.client('nimble')
These are the available methods:
Accept EULAs.
See also: AWS API Documentation
Request Syntax
response = client.accept_eulas(
clientToken='string',
eulaIds=[
'string',
],
studioId='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.
The EULA ID.
[REQUIRED]
A collection of EULA IDs.
dict
Response Syntax
{
'eulaAcceptances': [
{
'acceptedAt': datetime(2015, 1, 1),
'acceptedBy': 'string',
'accepteeId': 'string',
'eulaAcceptanceId': 'string',
'eulaId': 'string'
},
]
}
Response Structure
(dict) --
eulaAcceptances (list) --
A collection of EULA acceptances.
(dict) --
The acceptance of a EULA, required to use Amazon-provided streaming images.
acceptedAt (datetime) --
The Unix epoch timestamp in seconds for when the EULA was accepted.
acceptedBy (string) --
The ID of the person who accepted the EULA.
accepteeId (string) --
The ID of the acceptee.
eulaAcceptanceId (string) --
The EULA acceptance ID.
eulaId (string) --
The EULA ID.
Exceptions
Check if an operation can be paginated.
Create a launch profile.
See also: AWS API Documentation
Request Syntax
response = 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'
}
)
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.
[REQUIRED]
Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.
[REQUIRED]
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
[REQUIRED]
The name for the launch profile.
[REQUIRED]
A configuration for a streaming session.
Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
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.
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.
The streaming images that users can select from when launching a streaming session with this launch profile.
[REQUIRED]
Unique identifiers for a collection of studio components that can be used with this launch profile.
[REQUIRED]
The studio ID.
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Creates a streaming image resource in a studio.
See also: AWS API Documentation
Request Syntax
response = client.create_streaming_image(
clientToken='string',
description='string',
ec2ImageId='string',
name='string',
studioId='string',
tags={
'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.
[REQUIRED]
The ID of an EC2 machine image with which to create this streaming image.
[REQUIRED]
A friendly name for a streaming image resource.
[REQUIRED]
The studio ID.
A collection of labels, in the form of key:value pairs, that apply to this resource.
dict
Response Syntax
{
'streamingImage': {
'arn': 'string',
'description': 'string',
'ec2ImageId': 'string',
'encryptionConfiguration': {
'keyArn': 'string',
'keyType': 'CUSTOMER_MANAGED_KEY'
},
'eulaIds': [
'string',
],
'name': 'string',
'owner': 'string',
'platform': 'string',
'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'streamingImageId': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
streamingImage (dict) --
The streaming image.
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.
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.
Exceptions
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
response = 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'
}
)
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.
[REQUIRED]
The studio ID.
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
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.
Exceptions
Creates a streaming session stream for a streaming session.
After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in state READY.
See also: AWS API Documentation
Request Syntax
response = client.create_streaming_session_stream(
clientToken='string',
expirationInSeconds=123,
sessionId='string',
studioId='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.
[REQUIRED]
The streaming session ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'stream': {
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'expiresAt': datetime(2015, 1, 1),
'ownedBy': 'string',
'state': 'READY'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAM_CREATE_IN_PROGRESS'|'STREAM_READY'|'STREAM_DELETE_IN_PROGRESS'|'STREAM_DELETED'|'INTERNAL_ERROR'|'NETWORK_CONNECTION_ERROR',
'streamId': 'string',
'url': 'string'
}
}
Response Structure
(dict) --
stream (dict) --
The stream.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session stream.
expiresAt (datetime) --
The Unix epoch timestamp in seconds for when the resource expires.
ownedBy (string) --
The user ID of the user that owns the streaming session.
state (string) --
The current state.
statusCode (string) --
The streaming session stream status code.
streamId (string) --
The stream ID.
url (string) --
The URL to connect to this stream using the DCV client.
Exceptions
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
response = 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'
)
[REQUIRED]
The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
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.
[REQUIRED]
A friendly name for the studio.
The studio encryption configuration.
The ARN for a KMS key that is used to encrypt studio data.
The type of KMS key that is used to encrypt studio data.
[REQUIRED]
The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.
A collection of labels, in the form of key:value pairs, that apply to this resource.
[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',
'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 Unix epoch 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 Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO 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.
updatedAt (datetime) --
The Unix epoch 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.
Exceptions
Creates a studio component resource.
See also: AWS API Documentation
Request Syntax
response = client.create_studio_component(
clientToken='string',
configuration={
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
description='string',
ec2SecurityGroupIds=[
'string',
],
initializationScripts=[
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
name='string',
scriptParameters=[
{
'key': 'string',
'value': 'string'
},
],
studioId='string',
subtype='AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
tags={
'string': 'string'
},
type='ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM'
)
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.
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration.
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
A collection of custom attributes for an Active Directory computer.
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
The name for the LDAP attribute.
The value for the LDAP attribute.
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
The configuration for a render farm that is associated with a studio resource.
The name of an Active Directory user that is used on ComputeFarm worker instances.
The endpoint of the ComputeFarm that is accessed by the studio component resource.
The configuration for a license service that is associated with a studio resource.
The endpoint of the license service that is accessed by the studio component resource.
The configuration for a shared file storage system that is associated with a studio resource.
The endpoint of the shared file system that is accessed by the studio component resource.
The unique identifier for a file system.
The mount location for a shared file system on a Linux virtual workstation.
The name of the file share.
The mount location for a shared file system on a Windows virtual workstation.
The EC2 security groups that control access to the studio component.
Initialization scripts for studio components.
Initialization scripts for studio components.
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
The platform of the initialization script, either WINDOWS or LINUX.
The method to use when running the initialization script.
The initialization script.
[REQUIRED]
The name for the studio component.
Parameters for the studio component scripts.
A parameter for a studio component script, in the form of a key:value pair.
A script parameter key.
A script parameter value.
[REQUIRED]
The studio ID.
A collection of labels, in the form of key:value pairs, that apply to this resource.
[REQUIRED]
The type of the studio component.
dict
Response Syntax
{
'studioComponent': {
'arn': 'string',
'configuration': {
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'ec2SecurityGroupIds': [
'string',
],
'initializationScripts': [
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
'name': 'string',
'scriptParameters': [
{
'key': 'string',
'value': 'string'
},
],
'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'studioComponentId': 'string',
'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
'tags': {
'string': 'string'
},
'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
studioComponent (dict) --
Information about the studio component.
arn (string) --
The ARN of the resource.
configuration (dict) --
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
activeDirectoryConfiguration (dict) --
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
organizationalUnitDistinguishedName (string) --
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --
The configuration for a render farm that is associated with a studio resource.
activeDirectoryUser (string) --
The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (string) --
The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --
The configuration for a license service that is associated with a studio resource.
endpoint (string) --
The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --
The configuration for a shared file storage system that is associated with a studio resource.
endpoint (string) --
The endpoint of the shared file system that is accessed by the studio component resource.
fileSystemId (string) --
The unique identifier for a file system.
linuxMountPoint (string) --
The mount location for a shared file system on a Linux virtual workstation.
shareName (string) --
The name of the file share.
windowsMountDrive (string) --
The mount location for a shared file system on a Windows virtual workstation.
createdAt (datetime) --
The 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) --
A human-readable description for the studio component resource.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
initializationScripts (list) --
Initialization scripts for studio components.
(dict) --
Initialization scripts for studio components.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
platform (string) --
The platform of the initialization script, either WINDOWS or LINUX.
runContext (string) --
The method to use when running the initialization script.
script (string) --
The initialization script.
name (string) --
A friendly name for the studio component resource.
scriptParameters (list) --
Parameters for the studio component scripts.
(dict) --
A parameter for a studio component script, in the form of a key:value pair.
key (string) --
A script parameter key.
value (string) --
A script parameter value.
state (string) --
The current state.
statusCode (string) --
The status code.
statusMessage (string) --
The status message for the studio component.
studioComponentId (string) --
The unique identifier for a studio component resource.
subtype (string) --
The specific subtype of a studio component.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Permanently delete a launch profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_launch_profile(
clientToken='string',
launchProfileId='string',
studioId='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.
[REQUIRED]
The Launch Profile ID.
[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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Delete a user from launch profile membership.
See also: AWS API Documentation
Request Syntax
response = client.delete_launch_profile_member(
clientToken='string',
launchProfileId='string',
principalId='string',
studioId='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.
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
[REQUIRED]
The studio ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Delete streaming image.
See also: AWS API Documentation
Request Syntax
response = client.delete_streaming_image(
clientToken='string',
streamingImageId='string',
studioId='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.
[REQUIRED]
The streaming image ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'streamingImage': {
'arn': 'string',
'description': 'string',
'ec2ImageId': 'string',
'encryptionConfiguration': {
'keyArn': 'string',
'keyType': 'CUSTOMER_MANAGED_KEY'
},
'eulaIds': [
'string',
],
'name': 'string',
'owner': 'string',
'platform': 'string',
'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'streamingImageId': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
streamingImage (dict) --
The streaming image.
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.
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.
Exceptions
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
response = client.delete_streaming_session(
clientToken='string',
sessionId='string',
studioId='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.
[REQUIRED]
The streaming session ID.
[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.
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.
Exceptions
Delete a studio resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_studio(
clientToken='string',
studioId='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.
[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',
'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 Unix epoch 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 Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO 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.
updatedAt (datetime) --
The Unix epoch 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.
Exceptions
Deletes a studio component resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_studio_component(
clientToken='string',
studioComponentId='string',
studioId='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.
[REQUIRED]
The studio component ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'studioComponent': {
'arn': 'string',
'configuration': {
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'ec2SecurityGroupIds': [
'string',
],
'initializationScripts': [
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
'name': 'string',
'scriptParameters': [
{
'key': 'string',
'value': 'string'
},
],
'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'studioComponentId': 'string',
'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
'tags': {
'string': 'string'
},
'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
studioComponent (dict) --
Information about the studio component.
arn (string) --
The ARN of the resource.
configuration (dict) --
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
activeDirectoryConfiguration (dict) --
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
organizationalUnitDistinguishedName (string) --
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --
The configuration for a render farm that is associated with a studio resource.
activeDirectoryUser (string) --
The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (string) --
The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --
The configuration for a license service that is associated with a studio resource.
endpoint (string) --
The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --
The configuration for a shared file storage system that is associated with a studio resource.
endpoint (string) --
The endpoint of the shared file system that is accessed by the studio component resource.
fileSystemId (string) --
The unique identifier for a file system.
linuxMountPoint (string) --
The mount location for a shared file system on a Linux virtual workstation.
shareName (string) --
The name of the file share.
windowsMountDrive (string) --
The mount location for a shared file system on a Windows virtual workstation.
createdAt (datetime) --
The 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) --
A human-readable description for the studio component resource.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
initializationScripts (list) --
Initialization scripts for studio components.
(dict) --
Initialization scripts for studio components.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
platform (string) --
The platform of the initialization script, either WINDOWS or LINUX.
runContext (string) --
The method to use when running the initialization script.
script (string) --
The initialization script.
name (string) --
A friendly name for the studio component resource.
scriptParameters (list) --
Parameters for the studio component scripts.
(dict) --
A parameter for a studio component script, in the form of a key:value pair.
key (string) --
A script parameter key.
value (string) --
A script parameter value.
state (string) --
The current state.
statusCode (string) --
The status code.
statusMessage (string) --
The status message for the studio component.
studioComponentId (string) --
The unique identifier for a studio component resource.
subtype (string) --
The specific subtype of a studio component.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Delete a user from studio membership.
See also: AWS API Documentation
Request Syntax
response = client.delete_studio_member(
clientToken='string',
principalId='string',
studioId='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.
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
[REQUIRED]
The studio ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Get Eula.
See also: AWS API Documentation
Request Syntax
response = client.get_eula(
eulaId='string'
)
[REQUIRED]
The EULA ID.
{
'eula': {
'content': 'string',
'createdAt': datetime(2015, 1, 1),
'eulaId': 'string',
'name': 'string',
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
The EULA.
The EULA content.
The Unix epoch timestamp in seconds for when the resource was created.
The EULA ID.
The name for the EULA.
The Unix epoch timestamp in seconds for when the resource was updated.
Exceptions
Get a launch profile.
See also: AWS API Documentation
Request Syntax
response = client.get_launch_profile(
launchProfileId='string',
studioId='string'
)
[REQUIRED]
The Launch Profile ID.
[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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
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
response = client.get_launch_profile_details(
launchProfileId='string',
studioId='string'
)
[REQUIRED]
The Launch Profile ID.
[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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
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.
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.
Exceptions
Get a launch profile initialization.
See also: AWS API Documentation
Request Syntax
response = client.get_launch_profile_initialization(
launchProfileId='string',
launchProfileProtocolVersions=[
'string',
],
launchPurpose='string',
platform='string',
studioId='string'
)
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The launch profile protocol versions supported by the client.
[REQUIRED]
The launch purpose.
[REQUIRED]
The platform where this Launch Profile will be used, either WINDOWS or LINUX.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'launchProfileInitialization': {
'activeDirectory': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'directoryName': 'string',
'dnsIpAddresses': [
'string',
],
'organizationalUnitDistinguishedName': 'string',
'studioComponentId': 'string',
'studioComponentName': 'string'
},
'ec2SecurityGroupIds': [
'string',
],
'launchProfileId': 'string',
'launchProfileProtocolVersion': 'string',
'launchPurpose': 'string',
'name': 'string',
'platform': 'LINUX'|'WINDOWS',
'systemInitializationScripts': [
{
'script': 'string',
'studioComponentId': 'string',
'studioComponentName': 'string'
},
],
'userInitializationScripts': [
{
'script': 'string',
'studioComponentId': 'string',
'studioComponentName': 'string'
},
]
}
}
Response Structure
(dict) --
launchProfileInitialization (dict) --
The launch profile initialization.
activeDirectory (dict) --
A LaunchProfileInitializationActiveDirectory resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this launch profile.
directoryName (string) --
The directory name.
dnsIpAddresses (list) --
The DNS IP address.
organizationalUnitDistinguishedName (string) --
The name for the organizational unit distinguished name.
studioComponentId (string) --
The unique identifier for a studio component resource.
studioComponentName (string) --
The name for the studio component.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
launchProfileId (string) --
The launch profile ID.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
launchPurpose (string) --
The launch purpose.
name (string) --
The name for the launch profile.
platform (string) --
The platform of the launch platform, either WINDOWS or LINUX.
systemInitializationScripts (list) --
The system initializtion scripts.
(dict) --
script (string) --
The initialization script.
studioComponentId (string) --
The unique identifier for a studio component resource.
studioComponentName (string) --
The name for the studio component.
userInitializationScripts (list) --
The user initializtion scripts.
(dict) --
script (string) --
The initialization script.
studioComponentId (string) --
The unique identifier for a studio component resource.
studioComponentName (string) --
The name for the studio component.
Exceptions
Get a user persona in launch profile membership.
See also: AWS API Documentation
Request Syntax
response = client.get_launch_profile_member(
launchProfileId='string',
principalId='string',
studioId='string'
)
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
[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.
Exceptions
Create a paginator for an operation.
Get streaming image.
See also: AWS API Documentation
Request Syntax
response = client.get_streaming_image(
streamingImageId='string',
studioId='string'
)
[REQUIRED]
The streaming image ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'streamingImage': {
'arn': 'string',
'description': 'string',
'ec2ImageId': 'string',
'encryptionConfiguration': {
'keyArn': 'string',
'keyType': 'CUSTOMER_MANAGED_KEY'
},
'eulaIds': [
'string',
],
'name': 'string',
'owner': 'string',
'platform': 'string',
'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'streamingImageId': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
streamingImage (dict) --
The streaming image.
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.
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.
Exceptions
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
response = client.get_streaming_session(
sessionId='string',
studioId='string'
)
[REQUIRED]
The streaming session ID.
[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.
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.
Exceptions
Gets a StreamingSessionStream for a streaming session.
Invoke this operation to poll the resource after invoking CreateStreamingSessionStream.
After the StreamingSessionStream changes to the state READY, the url property will contain a stream to be used with the DCV streaming client.
See also: AWS API Documentation
Request Syntax
response = client.get_streaming_session_stream(
sessionId='string',
streamId='string',
studioId='string'
)
[REQUIRED]
The streaming session ID.
[REQUIRED]
The streaming session stream ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'stream': {
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'expiresAt': datetime(2015, 1, 1),
'ownedBy': 'string',
'state': 'READY'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAM_CREATE_IN_PROGRESS'|'STREAM_READY'|'STREAM_DELETE_IN_PROGRESS'|'STREAM_DELETED'|'INTERNAL_ERROR'|'NETWORK_CONNECTION_ERROR',
'streamId': 'string',
'url': 'string'
}
}
Response Structure
(dict) --
stream (dict) --
The stream.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
createdBy (string) --
The user ID of the user that created the streaming session stream.
expiresAt (datetime) --
The Unix epoch timestamp in seconds for when the resource expires.
ownedBy (string) --
The user ID of the user that owns the streaming session.
state (string) --
The current state.
statusCode (string) --
The streaming session stream status code.
streamId (string) --
The stream ID.
url (string) --
The URL to connect to this stream using the DCV client.
Exceptions
Get a Studio resource.
See also: AWS API Documentation
Request Syntax
response = client.get_studio(
studioId='string'
)
[REQUIRED]
The studio ID.
{
'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',
'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
Information about a studio.
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
The Unix epoch timestamp in seconds for when the resource was created.
A friendly name for the studio.
The Amazon Web Services Region where the studio resource is located.
The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.
The current state of the studio resource.
Status codes that provide additional detail on the studio state.
Additional detail on the studio state.
Configuration of the encryption method that is used for the studio.
The ARN for a KMS key that is used to encrypt studio data.
The type of KMS key that is used to encrypt studio data.
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
The address of the web page for the studio.
A collection of labels, in the form of key:value pairs, that apply to this resource.
The Unix epoch timestamp in seconds for when the resource was updated.
The IAM role that studio users assume when logging in to the Nimble Studio portal.
Exceptions
Gets a studio component resource.
See also: AWS API Documentation
Request Syntax
response = client.get_studio_component(
studioComponentId='string',
studioId='string'
)
[REQUIRED]
The studio component ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'studioComponent': {
'arn': 'string',
'configuration': {
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'ec2SecurityGroupIds': [
'string',
],
'initializationScripts': [
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
'name': 'string',
'scriptParameters': [
{
'key': 'string',
'value': 'string'
},
],
'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'studioComponentId': 'string',
'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
'tags': {
'string': 'string'
},
'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
studioComponent (dict) --
Information about the studio component.
arn (string) --
The ARN of the resource.
configuration (dict) --
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
activeDirectoryConfiguration (dict) --
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
organizationalUnitDistinguishedName (string) --
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --
The configuration for a render farm that is associated with a studio resource.
activeDirectoryUser (string) --
The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (string) --
The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --
The configuration for a license service that is associated with a studio resource.
endpoint (string) --
The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --
The configuration for a shared file storage system that is associated with a studio resource.
endpoint (string) --
The endpoint of the shared file system that is accessed by the studio component resource.
fileSystemId (string) --
The unique identifier for a file system.
linuxMountPoint (string) --
The mount location for a shared file system on a Linux virtual workstation.
shareName (string) --
The name of the file share.
windowsMountDrive (string) --
The mount location for a shared file system on a Windows virtual workstation.
createdAt (datetime) --
The 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) --
A human-readable description for the studio component resource.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
initializationScripts (list) --
Initialization scripts for studio components.
(dict) --
Initialization scripts for studio components.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
platform (string) --
The platform of the initialization script, either WINDOWS or LINUX.
runContext (string) --
The method to use when running the initialization script.
script (string) --
The initialization script.
name (string) --
A friendly name for the studio component resource.
scriptParameters (list) --
Parameters for the studio component scripts.
(dict) --
A parameter for a studio component script, in the form of a key:value pair.
key (string) --
A script parameter key.
value (string) --
A script parameter value.
state (string) --
The current state.
statusCode (string) --
The status code.
statusMessage (string) --
The status message for the studio component.
studioComponentId (string) --
The unique identifier for a studio component resource.
subtype (string) --
The specific subtype of a studio component.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Get a user's membership in a studio.
See also: AWS API Documentation
Request Syntax
response = client.get_studio_member(
principalId='string',
studioId='string'
)
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
[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.
Exceptions
Returns an object that can wait for some condition.
List Eula Acceptances.
See also: AWS API Documentation
Request Syntax
response = client.list_eula_acceptances(
eulaIds=[
'string',
],
nextToken='string',
studioId='string'
)
The list of EULA IDs that have been previously accepted.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'eulaAcceptances': [
{
'acceptedAt': datetime(2015, 1, 1),
'acceptedBy': 'string',
'accepteeId': 'string',
'eulaAcceptanceId': 'string',
'eulaId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
eulaAcceptances (list) --
A collection of EULA acceptances.
(dict) --
The acceptance of a EULA, required to use Amazon-provided streaming images.
acceptedAt (datetime) --
The Unix epoch timestamp in seconds for when the EULA was accepted.
acceptedBy (string) --
The ID of the person who accepted the EULA.
accepteeId (string) --
The ID of the acceptee.
eulaAcceptanceId (string) --
The EULA acceptance ID.
eulaId (string) --
The EULA ID.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Exceptions
List Eulas.
See also: AWS API Documentation
Request Syntax
response = client.list_eulas(
eulaIds=[
'string',
],
nextToken='string'
)
The list of EULA IDs that should be returned
dict
Response Syntax
{
'eulas': [
{
'content': 'string',
'createdAt': datetime(2015, 1, 1),
'eulaId': 'string',
'name': 'string',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
eulas (list) --
A collection of EULA resources.
(dict) --
Represents a EULA resource.
content (string) --
The EULA content.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
eulaId (string) --
The EULA ID.
name (string) --
The name for the EULA.
updatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was updated.
nextToken (string) --
The token for the next set of results, or null if there are no more results.
Exceptions
Get all users in a given launch profile membership.
See also: AWS API Documentation
Request Syntax
response = client.list_launch_profile_members(
launchProfileId='string',
maxResults=123,
nextToken='string',
studioId='string'
)
[REQUIRED]
The Launch Profile ID.
[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.
Exceptions
List all the launch profiles a studio.
See also: AWS API Documentation
Request Syntax
response = client.list_launch_profiles(
maxResults=123,
nextToken='string',
principalId='string',
states=[
'string',
],
studioId='string'
)
Filter this request to launch profiles in any of the given states.
[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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
List the streaming image resources available to this studio.
This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
See also: AWS API Documentation
Request Syntax
response = client.list_streaming_images(
nextToken='string',
owner='string',
studioId='string'
)
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'nextToken': 'string',
'streamingImages': [
{
'arn': 'string',
'description': 'string',
'ec2ImageId': 'string',
'encryptionConfiguration': {
'keyArn': 'string',
'keyType': 'CUSTOMER_MANAGED_KEY'
},
'eulaIds': [
'string',
],
'name': 'string',
'owner': 'string',
'platform': 'string',
'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'streamingImageId': 'string',
'tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
streamingImages (list) --
A collection of streaming images.
(dict) --
Represents a streaming image resource.
Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
Amazon provides a number of streaming images that include popular 3rd-party software.
You can create your own streaming images using an Amazon 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.
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.
Exceptions
Lists the streaming image resources in a studio.
See also: AWS API Documentation
Request Syntax
response = client.list_streaming_sessions(
createdBy='string',
nextToken='string',
ownedBy='string',
sessionIds='string',
studioId='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.
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.
Exceptions
Lists the StudioComponents in a studio.
See also: AWS API Documentation
Request Syntax
response = client.list_studio_components(
maxResults=123,
nextToken='string',
states=[
'string',
],
studioId='string',
types=[
'string',
]
)
Filters the request to studio components that are in one of the given states.
[REQUIRED]
The studio ID.
Filters the request to studio components that are of one of the given types.
dict
Response Syntax
{
'nextToken': 'string',
'studioComponents': [
{
'arn': 'string',
'configuration': {
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'ec2SecurityGroupIds': [
'string',
],
'initializationScripts': [
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
'name': 'string',
'scriptParameters': [
{
'key': 'string',
'value': 'string'
},
],
'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'studioComponentId': 'string',
'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
'tags': {
'string': 'string'
},
'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token for the next set of results, or null if there are no more results.
studioComponents (list) --
A collection of studio components.
(dict) --
A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.
Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.
A studio component also has a set of initialization scripts that are returned by GetLaunchProfileInitialization . These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.
arn (string) --
The ARN of the resource.
configuration (dict) --
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
activeDirectoryConfiguration (dict) --
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
organizationalUnitDistinguishedName (string) --
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --
The configuration for a render farm that is associated with a studio resource.
activeDirectoryUser (string) --
The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (string) --
The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --
The configuration for a license service that is associated with a studio resource.
endpoint (string) --
The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --
The configuration for a shared file storage system that is associated with a studio resource.
endpoint (string) --
The endpoint of the shared file system that is accessed by the studio component resource.
fileSystemId (string) --
The unique identifier for a file system.
linuxMountPoint (string) --
The mount location for a shared file system on a Linux virtual workstation.
shareName (string) --
The name of the file share.
windowsMountDrive (string) --
The mount location for a shared file system on a Windows virtual workstation.
createdAt (datetime) --
The 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) --
A human-readable description for the studio component resource.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
initializationScripts (list) --
Initialization scripts for studio components.
(dict) --
Initialization scripts for studio components.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
platform (string) --
The platform of the initialization script, either WINDOWS or LINUX.
runContext (string) --
The method to use when running the initialization script.
script (string) --
The initialization script.
name (string) --
A friendly name for the studio component resource.
scriptParameters (list) --
Parameters for the studio component scripts.
(dict) --
A parameter for a studio component script, in the form of a key:value pair.
key (string) --
A script parameter key.
value (string) --
A script parameter value.
state (string) --
The current state.
statusCode (string) --
The status code.
statusMessage (string) --
The status message for the studio component.
studioComponentId (string) --
The unique identifier for a studio component resource.
subtype (string) --
The specific subtype of a studio component.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Get all users in a given studio membership.
See also: AWS API Documentation
Request Syntax
response = client.list_studio_members(
maxResults=123,
nextToken='string',
studioId='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.
Exceptions
List studios in your Amazon Web Services account in the requested Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.list_studios(
nextToken='string'
)
{
'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',
'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
The token for the next set of results, or null if there are no more results.
A collection of studios.
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 Amazon Web Services SSO 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.
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
The Unix epoch timestamp in seconds for when the resource was created.
A friendly name for the studio.
The Amazon Web Services Region where the studio resource is located.
The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.
The current state of the studio resource.
Status codes that provide additional detail on the studio state.
Additional detail on the studio state.
Configuration of the encryption method that is used for the studio.
The ARN for a KMS key that is used to encrypt studio data.
The type of KMS key that is used to encrypt studio data.
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
The address of the web page for the studio.
A collection of labels, in the form of key:value pairs, that apply to this resource.
The Unix epoch timestamp in seconds for when the resource was updated.
The IAM role that studio users assume when logging in to the Nimble Studio portal.
Exceptions
Gets the tags for a resource, given its Amazon Resource Names (ARN).
This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource for which you want to list tags.
{
'tags': {
'string': 'string'
}
}
Response Structure
A collection of labels, in the form of key:value pairs, that apply to this resource.
Exceptions
Add/update users with given persona to launch profile membership.
See also: AWS API Documentation
Request Syntax
response = client.put_launch_profile_members(
clientToken='string',
identityStoreId='string',
launchProfileId='string',
members=[
{
'persona': 'USER',
'principalId': 'string'
},
],
studioId='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.
[REQUIRED]
The ID of the identity store.
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
A list of members.
The persona.
The principal ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Add/update users with given persona to studio membership.
See also: AWS API Documentation
Request Syntax
response = client.put_studio_members(
clientToken='string',
identityStoreId='string',
members=[
{
'persona': 'ADMINISTRATOR',
'principalId': 'string'
},
],
studioId='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.
[REQUIRED]
The ID of the identity store.
[REQUIRED]
A list of members.
The persona.
The principal ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{}
Response Structure
Exceptions
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
response = client.start_streaming_session(
clientToken='string',
sessionId='string',
studioId='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.
[REQUIRED]
The streaming session ID for the StartStreamingSessionRequest.
[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.
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.
Exceptions
Repairs the Amazon Web Services SSO configuration for a given studio.
If the studio has a valid Amazon Web Services SSO configuration currently associated with it, this operation will fail with a validation error.
If the studio does not have a valid Amazon Web Services SSO configuration currently associated with it, then a new Amazon Web Services SSO application is created for the studio and the studio is changed to the READY state.
After the Amazon Web Services SSO 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
response = client.start_studio_sso_configuration_repair(
clientToken='string',
studioId='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.
[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',
'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 Unix epoch 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 Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO 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.
updatedAt (datetime) --
The Unix epoch 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.
Exceptions
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
response = client.stop_streaming_session(
clientToken='string',
sessionId='string',
studioId='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.
[REQUIRED]
The streaming session ID for the StopStreamingSessionRequest.
[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.
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.
Exceptions
Creates tags for a resource, given its ARN.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource you want to add tags to.
A collection of labels, in the form of key:value pairs, that apply to this resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes the tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
Identifies the Amazon Resource Name(ARN) key from which you are removing tags.
[REQUIRED]
One or more tag keys. Specify only the tag keys, not the tag values.
dict
Response Syntax
{}
Response Structure
Exceptions
Update a launch profile.
See also: AWS API Documentation
Request Syntax
response = 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'
)
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.
[REQUIRED]
The Launch Profile ID.
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
A configuration for a streaming session.
Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
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.
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.
The streaming images that users can select from when launching a streaming session with this launch profile.
Unique identifiers for a collection of studio components that can be used with this launch profile.
[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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
Update a user persona in launch profile membership.
See also: AWS API Documentation
Request Syntax
response = client.update_launch_profile_member(
clientToken='string',
launchProfileId='string',
persona='USER',
principalId='string',
studioId='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.
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The persona.
[REQUIRED]
The principal ID. This currently supports a Amazon Web Services SSO UserId.
[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.
Exceptions
Update streaming image.
See also: AWS API Documentation
Request Syntax
response = client.update_streaming_image(
clientToken='string',
description='string',
name='string',
streamingImageId='string',
studioId='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.
[REQUIRED]
The streaming image ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'streamingImage': {
'arn': 'string',
'description': 'string',
'ec2ImageId': 'string',
'encryptionConfiguration': {
'keyArn': 'string',
'keyType': 'CUSTOMER_MANAGED_KEY'
},
'eulaIds': [
'string',
],
'name': 'string',
'owner': 'string',
'platform': 'string',
'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'streamingImageId': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
streamingImage (dict) --
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.
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.
Exceptions
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
See also: AWS API Documentation
Request Syntax
response = client.update_studio(
adminRoleArn='string',
clientToken='string',
displayName='string',
studioId='string',
userRoleArn='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.
[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',
'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 Unix epoch 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 Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO 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.
updatedAt (datetime) --
The Unix epoch 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.
Exceptions
Updates a studio component resource.
See also: AWS API Documentation
Request Syntax
response = client.update_studio_component(
clientToken='string',
configuration={
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
description='string',
ec2SecurityGroupIds=[
'string',
],
initializationScripts=[
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
name='string',
scriptParameters=[
{
'key': 'string',
'value': 'string'
},
],
studioComponentId='string',
studioId='string',
subtype='AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
type='ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM'
)
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.
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration.
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
A collection of custom attributes for an Active Directory computer.
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
The name for the LDAP attribute.
The value for the LDAP attribute.
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
The configuration for a render farm that is associated with a studio resource.
The name of an Active Directory user that is used on ComputeFarm worker instances.
The endpoint of the ComputeFarm that is accessed by the studio component resource.
The configuration for a license service that is associated with a studio resource.
The endpoint of the license service that is accessed by the studio component resource.
The configuration for a shared file storage system that is associated with a studio resource.
The endpoint of the shared file system that is accessed by the studio component resource.
The unique identifier for a file system.
The mount location for a shared file system on a Linux virtual workstation.
The name of the file share.
The mount location for a shared file system on a Windows virtual workstation.
The EC2 security groups that control access to the studio component.
Initialization scripts for studio components.
Initialization scripts for studio components.
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
The platform of the initialization script, either WINDOWS or LINUX.
The method to use when running the initialization script.
The initialization script.
Parameters for the studio component scripts.
A parameter for a studio component script, in the form of a key:value pair.
A script parameter key.
A script parameter value.
[REQUIRED]
The studio component ID.
[REQUIRED]
The studio ID.
dict
Response Syntax
{
'studioComponent': {
'arn': 'string',
'configuration': {
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'ec2SecurityGroupIds': [
'string',
],
'initializationScripts': [
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
'name': 'string',
'scriptParameters': [
{
'key': 'string',
'value': 'string'
},
],
'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'studioComponentId': 'string',
'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
'tags': {
'string': 'string'
},
'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
}
}
Response Structure
(dict) --
studioComponent (dict) --
Information about the studio component.
arn (string) --
The ARN of the resource.
configuration (dict) --
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
activeDirectoryConfiguration (dict) --
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
organizationalUnitDistinguishedName (string) --
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --
The configuration for a render farm that is associated with a studio resource.
activeDirectoryUser (string) --
The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (string) --
The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --
The configuration for a license service that is associated with a studio resource.
endpoint (string) --
The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --
The configuration for a shared file storage system that is associated with a studio resource.
endpoint (string) --
The endpoint of the shared file system that is accessed by the studio component resource.
fileSystemId (string) --
The unique identifier for a file system.
linuxMountPoint (string) --
The mount location for a shared file system on a Linux virtual workstation.
shareName (string) --
The name of the file share.
windowsMountDrive (string) --
The mount location for a shared file system on a Windows virtual workstation.
createdAt (datetime) --
The 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) --
A human-readable description for the studio component resource.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
initializationScripts (list) --
Initialization scripts for studio components.
(dict) --
Initialization scripts for studio components.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
platform (string) --
The platform of the initialization script, either WINDOWS or LINUX.
runContext (string) --
The method to use when running the initialization script.
script (string) --
The initialization script.
name (string) --
A friendly name for the studio component resource.
scriptParameters (list) --
Parameters for the studio component scripts.
(dict) --
A parameter for a studio component script, in the form of a key:value pair.
key (string) --
A script parameter key.
value (string) --
A script parameter value.
state (string) --
The current state.
statusCode (string) --
The status code.
statusMessage (string) --
The status message for the studio component.
studioComponentId (string) --
The unique identifier for a studio component resource.
subtype (string) --
The specific subtype of a studio component.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_eula_acceptances')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_eula_acceptances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
eulaIds=[
'string',
],
studioId='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The list of EULA IDs that have been previously accepted.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'eulaAcceptances': [
{
'acceptedAt': datetime(2015, 1, 1),
'acceptedBy': 'string',
'accepteeId': 'string',
'eulaAcceptanceId': 'string',
'eulaId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
eulaAcceptances (list) --
A collection of EULA acceptances.
(dict) --
The acceptance of a EULA, required to use Amazon-provided streaming images.
acceptedAt (datetime) --
The Unix epoch timestamp in seconds for when the EULA was accepted.
acceptedBy (string) --
The ID of the person who accepted the EULA.
accepteeId (string) --
The ID of the acceptee.
eulaAcceptanceId (string) --
The EULA acceptance ID.
eulaId (string) --
The EULA ID.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_eulas')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_eulas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
eulaIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The list of EULA IDs that should be returned
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'eulas': [
{
'content': 'string',
'createdAt': datetime(2015, 1, 1),
'eulaId': 'string',
'name': 'string',
'updatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
eulas (list) --
A collection of EULA resources.
(dict) --
Represents a EULA resource.
content (string) --
The EULA content.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
eulaId (string) --
The EULA ID.
name (string) --
The name for the EULA.
updatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was updated.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_launch_profile_members')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_launch_profile_members().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
launchProfileId='string',
studioId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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) --
A token to resume pagination.
paginator = client.get_paginator('list_launch_profiles')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_launch_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
principalId='string',
states=[
'string',
],
studioId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filter this request to launch profiles in any of the given states.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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.
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.
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.
studioComponentIds (list) --
Unique identifiers for a collection of studio components that can be used with this launch profile.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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) --
A token to resume pagination.
paginator = client.get_paginator('list_streaming_images')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_streaming_images().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
owner='string',
studioId='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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.
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_streaming_sessions')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_streaming_sessions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
createdBy='string',
ownedBy='string',
sessionIds='string',
studioId='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'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'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
sessions (list) --
A collection of streaming sessions.
(dict) --
A streaming session is a virtual workstation created using a particular launch profile.
arn (string) --
The 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.
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_studio_components')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_studio_components().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
states=[
'string',
],
studioId='string',
types=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the request to studio components that are in one of the given states.
[REQUIRED]
The studio ID.
Filters the request to studio components that are of one of the given types.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'studioComponents': [
{
'arn': 'string',
'configuration': {
'activeDirectoryConfiguration': {
'computerAttributes': [
{
'name': 'string',
'value': 'string'
},
],
'directoryId': 'string',
'organizationalUnitDistinguishedName': 'string'
},
'computeFarmConfiguration': {
'activeDirectoryUser': 'string',
'endpoint': 'string'
},
'licenseServiceConfiguration': {
'endpoint': 'string'
},
'sharedFileSystemConfiguration': {
'endpoint': 'string',
'fileSystemId': 'string',
'linuxMountPoint': 'string',
'shareName': 'string',
'windowsMountDrive': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'description': 'string',
'ec2SecurityGroupIds': [
'string',
],
'initializationScripts': [
{
'launchProfileProtocolVersion': 'string',
'platform': 'LINUX'|'WINDOWS',
'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
'script': 'string'
},
],
'name': 'string',
'scriptParameters': [
{
'key': 'string',
'value': 'string'
},
],
'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
'statusCode': 'ACTIVE_DIRECTORY_ALREADY_EXISTS'|'STUDIO_COMPONENT_CREATED'|'STUDIO_COMPONENT_UPDATED'|'STUDIO_COMPONENT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'STUDIO_COMPONENT_CREATE_IN_PROGRESS'|'STUDIO_COMPONENT_UPDATE_IN_PROGRESS'|'STUDIO_COMPONENT_DELETE_IN_PROGRESS'|'INTERNAL_ERROR',
'statusMessage': 'string',
'studioComponentId': 'string',
'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
'tags': {
'string': 'string'
},
'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
'updatedAt': datetime(2015, 1, 1),
'updatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
studioComponents (list) --
A collection of studio components.
(dict) --
A studio component represents a network resource to be used by a studio's users and workflows. A typical studio contains studio components for each of the following: render farm, Active Directory, licensing, and file system.
Access to a studio component is managed by specifying security groups for the resource, as well as its endpoint.
A studio component also has a set of initialization scripts that are returned by GetLaunchProfileInitialization . These initialization scripts run on streaming sessions when they start. They provide users with flexibility in controlling how the studio resources are configured on a streaming session.
arn (string) --
The ARN of the resource.
configuration (dict) --
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: activeDirectoryConfiguration, computeFarmConfiguration, licenseServiceConfiguration, sharedFileSystemConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
activeDirectoryConfiguration (dict) --
The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.
computerAttributes (list) --
A collection of custom attributes for an Active Directory computer.
(dict) --
An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.
name (string) --
The name for the LDAP attribute.
value (string) --
The value for the LDAP attribute.
directoryId (string) --
The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.
organizationalUnitDistinguishedName (string) --
The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.
computeFarmConfiguration (dict) --
The configuration for a render farm that is associated with a studio resource.
activeDirectoryUser (string) --
The name of an Active Directory user that is used on ComputeFarm worker instances.
endpoint (string) --
The endpoint of the ComputeFarm that is accessed by the studio component resource.
licenseServiceConfiguration (dict) --
The configuration for a license service that is associated with a studio resource.
endpoint (string) --
The endpoint of the license service that is accessed by the studio component resource.
sharedFileSystemConfiguration (dict) --
The configuration for a shared file storage system that is associated with a studio resource.
endpoint (string) --
The endpoint of the shared file system that is accessed by the studio component resource.
fileSystemId (string) --
The unique identifier for a file system.
linuxMountPoint (string) --
The mount location for a shared file system on a Linux virtual workstation.
shareName (string) --
The name of the file share.
windowsMountDrive (string) --
The mount location for a shared file system on a Windows virtual workstation.
createdAt (datetime) --
The 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) --
A human-readable description for the studio component resource.
ec2SecurityGroupIds (list) --
The EC2 security groups that control access to the studio component.
initializationScripts (list) --
Initialization scripts for studio components.
(dict) --
Initialization scripts for studio components.
launchProfileProtocolVersion (string) --
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
platform (string) --
The platform of the initialization script, either WINDOWS or LINUX.
runContext (string) --
The method to use when running the initialization script.
script (string) --
The initialization script.
name (string) --
A friendly name for the studio component resource.
scriptParameters (list) --
Parameters for the studio component scripts.
(dict) --
A parameter for a studio component script, in the form of a key:value pair.
key (string) --
A script parameter key.
value (string) --
A script parameter value.
state (string) --
The current state.
statusCode (string) --
The status code.
statusMessage (string) --
The status message for the studio component.
studioComponentId (string) --
The unique identifier for a studio component resource.
subtype (string) --
The specific subtype of a studio component.
tags (dict) --
A collection of labels, in the form of key:value pairs, that apply to this resource.
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_studio_members')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_studio_members().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
studioId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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) --
A token to resume pagination.
paginator = client.get_paginator('list_studios')
Creates an iterator that will paginate through responses from NimbleStudio.Client.list_studios().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'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',
'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'
},
],
'NextToken': 'string'
}
Response Structure
A collection of studios.
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 Amazon Web Services SSO 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.
The IAM role that studio admins assume when logging in to the Nimble Studio portal.
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
The Unix epoch timestamp in seconds for when the resource was created.
A friendly name for the studio.
The Amazon Web Services Region where the studio resource is located.
The Amazon Web Services SSO application client ID used to integrate with Amazon Web Services SSO to enable Amazon Web Services SSO users to log in to Nimble Studio portal.
The current state of the studio resource.
Status codes that provide additional detail on the studio state.
Additional detail on the studio state.
Configuration of the encryption method that is used for the studio.
The ARN for a KMS key that is used to encrypt studio data.
The type of KMS key that is used to encrypt studio data.
The unique identifier for a studio resource. In Nimble Studio, all other resources are contained in a studio resource.
The name of the studio, as included in the URL when accessing it in the Nimble Studio portal.
The address of the web page for the studio.
A collection of labels, in the form of key:value pairs, that apply to this resource.
The Unix epoch timestamp in seconds for when the resource was updated.
The IAM role that studio users assume when logging in to the Nimble Studio portal.
A token to resume pagination.
The available waiters are:
waiter = client.get_waiter('launch_profile_deleted')
Polls NimbleStudio.Client.get_launch_profile() every 5 seconds until a successful state is reached. An error is returned after 150 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
launchProfileId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 150
None
waiter = client.get_waiter('launch_profile_ready')
Polls NimbleStudio.Client.get_launch_profile() every 5 seconds until a successful state is reached. An error is returned after 150 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
launchProfileId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Launch Profile ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 150
None
waiter = client.get_waiter('streaming_image_deleted')
Polls NimbleStudio.Client.get_streaming_image() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
streamingImageId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming image ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('streaming_image_ready')
Polls NimbleStudio.Client.get_streaming_image() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
streamingImageId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming image ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('streaming_session_deleted')
Polls NimbleStudio.Client.get_streaming_session() every 5 seconds until a successful state is reached. An error is returned after 180 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
sessionId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming session ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 180
None
waiter = client.get_waiter('streaming_session_ready')
Polls NimbleStudio.Client.get_streaming_session() every 10 seconds until a successful state is reached. An error is returned after 180 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
sessionId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming session ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 10
The maximum number of attempts to be made. Default: 180
None
waiter = client.get_waiter('streaming_session_stopped')
Polls NimbleStudio.Client.get_streaming_session() every 5 seconds until a successful state is reached. An error is returned after 180 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
sessionId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming session ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 180
None
waiter = client.get_waiter('streaming_session_stream_ready')
Polls NimbleStudio.Client.get_streaming_session_stream() every 5 seconds until a successful state is reached. An error is returned after 30 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
sessionId='string',
streamId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The streaming session ID.
[REQUIRED]
The streaming session stream ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 30
None
waiter = client.get_waiter('studio_component_deleted')
Polls NimbleStudio.Client.get_studio_component() every 1 seconds until a successful state is reached. An error is returned after 120 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
studioComponentId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The studio component ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 1
The maximum number of attempts to be made. Default: 120
None
waiter = client.get_waiter('studio_component_ready')
Polls NimbleStudio.Client.get_studio_component() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
studioComponentId='string',
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The studio component ID.
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('studio_deleted')
Polls NimbleStudio.Client.get_studio() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('studio_ready')
Polls NimbleStudio.Client.get_studio() every 2 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
studioId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The studio ID.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 2
The maximum number of attempts to be made. Default: 60
None