AWS API Changes

2021/12/21 - AmazonNimbleStudio - 11 updated api methods

Changes Amazon Nimble Studio adds support for users to upload files during a streaming session using NICE DCV native client or browser.

CreateLaunchProfile (updated)

Link ¶
Changes (request, response)
Request

{'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                            'root': {'linux': 'string',
                                                     'windows': 'string'}}}}

Response

{'launchProfile': {'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                                              'root': {'linux': 'string',
                                                                       'windows': 'string'}}}}}

Create a launch profile.

See also: AWS API Documentation

Request Syntax

client.create_launch_profile(
    clientToken='string',
    description='string',
    ec2SubnetIds=[
        'string',
    ],
    launchProfileProtocolVersions=[
        'string',
    ],
    name='string',
    streamConfiguration={
        'clipboardMode': 'ENABLED'|'DISABLED',
        'ec2InstanceTypes': [
            'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
        ],
        'maxSessionLengthInMinutes': 123,
        'maxStoppedSessionLengthInMinutes': 123,
        'sessionStorage': {
            'mode': [
                'UPLOAD',
            ],
            'root': {
                'linux': 'string',
                'windows': 'string'
            }
        },
        'streamingImageIds': [
            'string',
        ]
    },
    studioComponentIds=[
        'string',
    ],
    studioId='string',
    tags={
        'string': 'string'
    }
)

type clientToken

string

param clientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

This field is autopopulated if not provided.

type description

string

param description

The description.

type ec2SubnetIds

list

param ec2SubnetIds

[REQUIRED]

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

(string) --

type launchProfileProtocolVersions

list

param launchProfileProtocolVersions

[REQUIRED]

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

(string) --

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

type name

string

param name

[REQUIRED]

The name for the launch profile.

type streamConfiguration

dict

param streamConfiguration

[REQUIRED]

A configuration for a streaming session.

clipboardMode (string) -- [REQUIRED]

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

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

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

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

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

The streaming images that users can select from when launching a streaming session with this launch profile.
- (string) --

type studioComponentIds

list

param studioComponentIds

[REQUIRED]

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

(string) --

type studioId

string

param studioId

[REQUIRED]

The studio ID.

type tags

dict

param tags

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

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED',
        'statusMessage': 'string',
        'streamConfiguration': {
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ]
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The launch profile.
  - arn (string) --
    
    The ARN of the resource.
  - createdAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The launch profile ID.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - clipboardMode (string) --
      
      Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    - sessionStorage (dict) --
      
      (Optional) The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD .
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads .
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\Downloads .
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was updated.
  - updatedBy (string) --
    
    The user ID of the user that most recently updated the resource.

CreateStreamingImage (updated)

Link ¶
Changes (response)

{'streamingImage': {'statusCode': {'ACCESS_DENIED'}}}

Creates a streaming image resource in a studio.

See also: AWS API Documentation

Request Syntax

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

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

A human-readable description of the streaming image.

type ec2ImageId

string

param ec2ImageId

[REQUIRED]

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

type name

string

param name

[REQUIRED]

A friendly name for a streaming image resource.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

type tags

dict

param tags

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

(string) --
- (string) --

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- streamingImage (dict) --
  
  The streaming image.
  - arn (string) --
    
    The ARN of the resource.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either WINDOWS or LINUX.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - streamingImageId (string) --
    
    The ID of the streaming image.
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --

DeleteLaunchProfile (updated)

Link ¶
Changes (response)

{'launchProfile': {'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                                              'root': {'linux': 'string',
                                                                       'windows': 'string'}}}}}

Permanently delete a launch profile.

See also: AWS API Documentation

Request Syntax

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

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type launchProfileId

string

param launchProfileId

[REQUIRED]

The Launch Profile ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED',
        'statusMessage': 'string',
        'streamConfiguration': {
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ]
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The launch profile.
  - arn (string) --
    
    The ARN of the resource.
  - createdAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The launch profile ID.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - clipboardMode (string) --
      
      Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    - sessionStorage (dict) --
      
      (Optional) The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD .
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads .
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\Downloads .
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was updated.
  - updatedBy (string) --
    
    The user ID of the user that most recently updated the resource.

DeleteStreamingImage (updated)

Link ¶
Changes (response)

{'streamingImage': {'statusCode': {'ACCESS_DENIED'}}}

Delete streaming image.

See also: AWS API Documentation

Request Syntax

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

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type streamingImageId

string

param streamingImageId

[REQUIRED]

The streaming image ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- streamingImage (dict) --
  
  The streaming image.
  - arn (string) --
    
    The ARN of the resource.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either WINDOWS or LINUX.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - streamingImageId (string) --
    
    The ID of the streaming image.
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --

GetLaunchProfile (updated)

Link ¶
Changes (response)

{'launchProfile': {'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                                              'root': {'linux': 'string',
                                                                       'windows': 'string'}}}}}

Get a launch profile.

See also: AWS API Documentation

Request Syntax

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

type launchProfileId

string

param launchProfileId

[REQUIRED]

The Launch Profile ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED',
        'statusMessage': 'string',
        'streamConfiguration': {
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ]
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The launch profile.
  - arn (string) --
    
    The ARN of the resource.
  - createdAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The launch profile ID.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - clipboardMode (string) --
      
      Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    - sessionStorage (dict) --
      
      (Optional) The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD .
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads .
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\Downloads .
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was updated.
  - updatedBy (string) --
    
    The user ID of the user that most recently updated the resource.

GetLaunchProfileDetails (updated)

Link ¶
Changes (response)

{'launchProfile': {'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                                              'root': {'linux': 'string',
                                                                       'windows': 'string'}}}},
 'streamingImages': {'statusCode': {'ACCESS_DENIED'}}}

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

See also: AWS API Documentation

Request Syntax

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

type launchProfileId

string

param launchProfileId

[REQUIRED]

The Launch Profile ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED',
        'statusMessage': 'string',
        'streamConfiguration': {
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            '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'|'ACCESS_DENIED',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'studioComponentSummaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'name': 'string',
            'studioComponentId': 'string',
            'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
            'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The launch profile.
  - arn (string) --
    
    The ARN of the resource.
  - createdAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The launch profile ID.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - clipboardMode (string) --
      
      Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    - sessionStorage (dict) --
      
      (Optional) The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD .
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads .
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\Downloads .
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was updated.
  - updatedBy (string) --
    
    The user ID of the user that most recently updated the resource.
- streamingImages (list) --
  
  A collection of streaming images.
  - (dict) --
    
    Represents a streaming image resource.
    
    Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
    
    Amazon provides a number of streaming images that include popular 3rd-party software.
    
    You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.
    - arn (string) --
      
      The ARN of the resource.
    - description (string) --
      
      A human-readable description of the streaming image.
    - ec2ImageId (string) --
      
      The ID of an EC2 machine image with which to create the streaming image.
    - encryptionConfiguration (dict) --
      
      The encryption configuration.
      - keyArn (string) --
        
        The ARN for a KMS key that is used to encrypt studio data.
      - keyType (string) --
        
        The type of KMS key that is used to encrypt studio data.
    - eulaIds (list) --
      
      The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
      - (string) --
    - name (string) --
      
      A friendly name for a streaming image resource.
    - owner (string) --
      
      The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
    - platform (string) --
      
      The platform of the streaming image, either WINDOWS or LINUX.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the streaming image.
    - streamingImageId (string) --
      
      The ID of the streaming image.
    - tags (dict) --
      
      A collection of labels, in the form of key:value pairs, that apply to this resource.
      - (string) --
        
        (string) --
- studioComponentSummaries (list) --
  
  A collection of studio component summaries.
  - (dict) --
    
    The studio component's summary.
    - 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.

GetStreamingImage (updated)

Link ¶
Changes (response)

{'streamingImage': {'statusCode': {'ACCESS_DENIED'}}}

Get streaming image.

See also: AWS API Documentation

Request Syntax

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

type streamingImageId

string

param streamingImageId

[REQUIRED]

The streaming image ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- streamingImage (dict) --
  
  The streaming image.
  - arn (string) --
    
    The ARN of the resource.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either WINDOWS or LINUX.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - streamingImageId (string) --
    
    The ID of the streaming image.
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --

ListLaunchProfiles (updated)

Link ¶
Changes (response)

{'launchProfiles': {'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                                               'root': {'linux': 'string',
                                                                        'windows': 'string'}}}}}

List all the launch profiles a studio.

See also: AWS API Documentation

Request Syntax

client.list_launch_profiles(
    maxResults=123,
    nextToken='string',
    principalId='string',
    states=[
        'string',
    ],
    studioId='string'
)

type maxResults

integer

param maxResults

The max number of results to return in the response.

type nextToken

string

param nextToken

The token to request the next page of results.

type principalId

string

param principalId

The principal ID. This currently supports a Amazon Web Services SSO UserId.

type states

list

param states

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

(string) --

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'launchProfiles': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'ec2SubnetIds': [
                'string',
            ],
            'launchProfileId': 'string',
            'launchProfileProtocolVersions': [
                'string',
            ],
            'name': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED',
            'statusMessage': 'string',
            'streamConfiguration': {
                'clipboardMode': 'ENABLED'|'DISABLED',
                'ec2InstanceTypes': [
                    'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
                ],
                'maxSessionLengthInMinutes': 123,
                'maxStoppedSessionLengthInMinutes': 123,
                'sessionStorage': {
                    'mode': [
                        'UPLOAD',
                    ],
                    'root': {
                        'linux': 'string',
                        'windows': 'string'
                    }
                },
                'streamingImageIds': [
                    'string',
                ]
            },
            'studioComponentIds': [
                'string',
            ],
            'tags': {
                'string': 'string'
            },
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- launchProfiles (list) --
  
  A collection of launch profiles.
  - (dict) --
    
    A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).
    
    <p>Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.</p>
    - arn (string) --
      
      The ARN of the resource.
    - createdAt (datetime) --
      
      The Unix epoch timestamp in seconds for when the resource was created.
    - createdBy (string) --
      
      The user ID of the user that created the launch profile.
    - description (string) --
      
      A human-readable description of the launch profile.
    - ec2SubnetIds (list) --
      
      Unique identifiers for a collection of EC2 subnets.
      - (string) --
    - launchProfileId (string) --
      
      The launch profile ID.
    - launchProfileProtocolVersions (list) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
      - (string) --
        
        The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - name (string) --
      
      A friendly name for the launch profile.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the launch profile.
    - streamConfiguration (dict) --
      
      A configuration for a streaming session.
      - clipboardMode (string) --
        
        Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
      - ec2InstanceTypes (list) --
        
        The EC2 instance types that users can select from when launching a streaming session with this launch profile.
        
        (string) --
      - maxSessionLengthInMinutes (integer) --
        
        The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
      - maxStoppedSessionLengthInMinutes (integer) --
        
        Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
        
        If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
        
        If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
      - sessionStorage (dict) --
        
        (Optional) The upload storage for a streaming session.
        
        mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD .
        
        (string) --
        
        root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads .
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\Downloads .
      - streamingImageIds (list) --
        
        The streaming images that users can select from when launching a streaming session with this launch profile.
        
        (string) --
    - studioComponentIds (list) --
      
      Unique identifiers for a collection of studio components that can be used with this launch profile.
      - (string) --
    - tags (dict) --
      
      A collection of labels, in the form of key:value pairs, that apply to this resource.
      - (string) --
        
        (string) --
    - updatedAt (datetime) --
      
      The Unix epoch timestamp in seconds for when the resource was updated.
    - updatedBy (string) --
      
      The user ID of the user that most recently updated the resource.
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.

ListStreamingImages (updated)

Link ¶
Changes (response)

{'streamingImages': {'statusCode': {'ACCESS_DENIED'}}}

List the streaming image resources available to this studio.

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

See also: AWS API Documentation

Request Syntax

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

type nextToken

string

param nextToken

The token to request the next page of results.

type owner

string

param owner

Filter this request to streaming images with the given owner

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- nextToken (string) --
  
  The token for the next set of results, or null if there are no more results.
- streamingImages (list) --
  
  A collection of streaming images.
  - (dict) --
    
    Represents a streaming image resource.
    
    Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
    
    Amazon provides a number of streaming images that include popular 3rd-party software.
    
    You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.
    - arn (string) --
      
      The ARN of the resource.
    - description (string) --
      
      A human-readable description of the streaming image.
    - ec2ImageId (string) --
      
      The ID of an EC2 machine image with which to create the streaming image.
    - encryptionConfiguration (dict) --
      
      The encryption configuration.
      - keyArn (string) --
        
        The ARN for a KMS key that is used to encrypt studio data.
      - keyType (string) --
        
        The type of KMS key that is used to encrypt studio data.
    - eulaIds (list) --
      
      The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
      - (string) --
    - name (string) --
      
      A friendly name for a streaming image resource.
    - owner (string) --
      
      The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
    - platform (string) --
      
      The platform of the streaming image, either WINDOWS or LINUX.
    - state (string) --
      
      The current state.
    - statusCode (string) --
      
      The status code.
    - statusMessage (string) --
      
      The status message for the streaming image.
    - streamingImageId (string) --
      
      The ID of the streaming image.
    - tags (dict) --
      
      A collection of labels, in the form of key:value pairs, that apply to this resource.
      - (string) --
        
        (string) --

UpdateLaunchProfile (updated)

Link ¶
Changes (request, response)
Request

{'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                            'root': {'linux': 'string',
                                                     'windows': 'string'}}}}

Response

{'launchProfile': {'streamConfiguration': {'sessionStorage': {'mode': ['UPLOAD'],
                                                              'root': {'linux': 'string',
                                                                       'windows': 'string'}}}}}

Update a launch profile.

See also: AWS API Documentation

Request Syntax

client.update_launch_profile(
    clientToken='string',
    description='string',
    launchProfileId='string',
    launchProfileProtocolVersions=[
        'string',
    ],
    name='string',
    streamConfiguration={
        'clipboardMode': 'ENABLED'|'DISABLED',
        'ec2InstanceTypes': [
            'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
        ],
        'maxSessionLengthInMinutes': 123,
        'maxStoppedSessionLengthInMinutes': 123,
        'sessionStorage': {
            'mode': [
                'UPLOAD',
            ],
            'root': {
                'linux': 'string',
                'windows': 'string'
            }
        },
        'streamingImageIds': [
            'string',
        ]
    },
    studioComponentIds=[
        'string',
    ],
    studioId='string'
)

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

The description.

type launchProfileId

string

param launchProfileId

[REQUIRED]

The Launch Profile ID.

type launchProfileProtocolVersions

list

param launchProfileProtocolVersions

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

(string) --

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

type name

string

param name

The name for the launch profile.

type streamConfiguration

dict

param streamConfiguration

A configuration for a streaming session.

clipboardMode (string) -- [REQUIRED]

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

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

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

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

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

The streaming images that users can select from when launching a streaming session with this launch profile.
- (string) --

type studioComponentIds

list

param studioComponentIds

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

(string) --

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'launchProfile': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'createdBy': 'string',
        'description': 'string',
        'ec2SubnetIds': [
            'string',
        ],
        'launchProfileId': 'string',
        'launchProfileProtocolVersions': [
            'string',
        ],
        'name': 'string',
        'state': 'CREATE_IN_PROGRESS'|'READY'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'DELETED'|'DELETE_FAILED'|'CREATE_FAILED'|'UPDATE_FAILED',
        'statusCode': 'LAUNCH_PROFILE_CREATED'|'LAUNCH_PROFILE_UPDATED'|'LAUNCH_PROFILE_DELETED'|'LAUNCH_PROFILE_CREATE_IN_PROGRESS'|'LAUNCH_PROFILE_UPDATE_IN_PROGRESS'|'LAUNCH_PROFILE_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'STREAMING_IMAGE_NOT_FOUND'|'STREAMING_IMAGE_NOT_READY'|'LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED'|'ENCRYPTION_KEY_ACCESS_DENIED'|'ENCRYPTION_KEY_NOT_FOUND'|'INVALID_SUBNETS_PROVIDED',
        'statusMessage': 'string',
        'streamConfiguration': {
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ]
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

Response Structure

(dict) --
- launchProfile (dict) --
  
  The launch profile.
  - arn (string) --
    
    The ARN of the resource.
  - createdAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was created.
  - createdBy (string) --
    
    The user ID of the user that created the launch profile.
  - description (string) --
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) --
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) --
  - launchProfileId (string) --
    
    The launch profile ID.
  - launchProfileProtocolVersions (list) --
    
    The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
    - (string) --
      
      The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
  - name (string) --
    
    A friendly name for the launch profile.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the launch profile.
  - streamConfiguration (dict) --
    
    A configuration for a streaming session.
    - clipboardMode (string) --
      
      Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) --
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) --
    - maxSessionLengthInMinutes (integer) --
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) --
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      If the value is missing or set to 0, your sessions can’t be stopped. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated by AWS (instead of stopped).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped by AWS (instead of terminated).
    - sessionStorage (dict) --
      
      (Optional) The upload storage for a streaming session.
      - mode (list) --
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD .
        
        (string) --
      - root (dict) --
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) --
        
        The folder path in Linux workstations where files are uploaded. The default path is $HOME/Downloads .
        
        windows (string) --
        
        The folder path in Windows workstations where files are uploaded. The default path is %HOMEPATH%\Downloads .
    - streamingImageIds (list) --
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) --
  - studioComponentIds (list) --
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) --
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --
  - updatedAt (datetime) --
    
    The Unix epoch timestamp in seconds for when the resource was updated.
  - updatedBy (string) --
    
    The user ID of the user that most recently updated the resource.

UpdateStreamingImage (updated)

Link ¶
Changes (response)

{'streamingImage': {'statusCode': {'ACCESS_DENIED'}}}

Update streaming image.

See also: AWS API Documentation

Request Syntax

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

type clientToken

string

param clientToken

This field is autopopulated if not provided.

type description

string

param description

The description.

type name

string

param name

The name for the streaming image.

type streamingImageId

string

param streamingImageId

[REQUIRED]

The streaming image ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- streamingImage (dict) --
  
  Represents a streaming image resource.
  
  Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
  
  Amazon provides a number of streaming images that include popular 3rd-party software.
  
  You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.
  - arn (string) --
    
    The ARN of the resource.
  - description (string) --
    
    A human-readable description of the streaming image.
  - ec2ImageId (string) --
    
    The ID of an EC2 machine image with which to create the streaming image.
  - encryptionConfiguration (dict) --
    
    The encryption configuration.
    - keyArn (string) --
      
      The ARN for a KMS key that is used to encrypt studio data.
    - keyType (string) --
      
      The type of KMS key that is used to encrypt studio data.
  - eulaIds (list) --
    
    The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
    - (string) --
  - name (string) --
    
    A friendly name for a streaming image resource.
  - owner (string) --
    
    The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.
  - platform (string) --
    
    The platform of the streaming image, either WINDOWS or LINUX.
  - state (string) --
    
    The current state.
  - statusCode (string) --
    
    The status code.
  - statusMessage (string) --
    
    The status message for the streaming image.
  - streamingImageId (string) --
    
    The ID of the streaming image.
  - tags (dict) --
    
    A collection of labels, in the form of key:value pairs, that apply to this resource.
    - (string) --
      - (string) --