AmazonNimbleStudio

2022/01/13 - AmazonNimbleStudio - 13 updated api methods

Changes  Amazon Nimble Studio now supports validation for Launch Profiles. Launch Profiles now report static validation results after create/update to detect errors in network or active directory configuration.

CreateLaunchProfile (updated) Link ¶
Changes (response)
{'launchProfile': {'validationResults': [{'state': 'VALIDATION_NOT_STARTED | '
                                                   'VALIDATION_IN_PROGRESS | '
                                                   'VALIDATION_SUCCESS | '
                                                   'VALIDATION_FAILED | '
                                                   'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusCode': 'VALIDATION_NOT_STARTED '
                                                        '| '
                                                        'VALIDATION_IN_PROGRESS '
                                                        '| VALIDATION_SUCCESS '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_SUBNET_NOT_FOUND '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY '
                                                        '| '
                                                        'VALIDATION_FAILED_UNAUTHORIZED '
                                                        '| '
                                                        'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusMessage': 'string',
                                          'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT '
                                                  '| '
                                                  'VALIDATE_SUBNET_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_NETWORK_ACL_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_SECURITY_GROUP_ASSOCIATION'}]}}

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.

      • windows (string) --

        The folder path in Windows workstations where files are uploaded.

  • streamingImageIds (list) -- [REQUIRED]

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

    • (string) --

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',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • launchProfile (dict) --

      The launch profile.

      • arn (string) --

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

            • windows (string) --

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds (list) --

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

          • (string) --

      • 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.

      • validationResults (list) --

        The list of the latest validation results.

        • (dict) --

          The launch profile validation result.

          • state (string) --

            The current state.

          • statusCode (string) --

            The status code. This will contain the failure reason if the state is VALIDATION_FAILED .

          • statusMessage (string) --

            The status message for the validation result.

          • type (string) --

            The type of the validation result.

CreateStreamingSession (updated) Link ¶
Changes (response)
{'session': {'statusCode': {'AMI_VALIDATION_ERROR'}}}

Creates a streaming session in a studio.

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

See also: AWS API Documentation

Request Syntax

client.create_streaming_session(
    clientToken='string',
    ec2InstanceType='g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge',
    launchProfileId='string',
    ownedBy='string',
    streamingImageId='string',
    studioId='string',
    tags={
        'string': 'string'
    }
)
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 ec2InstanceType

string

param ec2InstanceType

The EC2 Instance type used for the streaming session.

type launchProfileId

string

param launchProfileId

The launch profile ID.

type ownedBy

string

param ownedBy

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

type streamingImageId

string

param streamingImageId

The ID of the streaming image.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

type tags

dict

param tags

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

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'session': {
        'arn': 'string',
        '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'|'AMI_VALIDATION_ERROR',
        'statusMessage': 'string',
        'stopAt': datetime(2015, 1, 1),
        'stoppedAt': datetime(2015, 1, 1),
        'stoppedBy': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

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. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId (string) --

        The session ID.

      • startedAt (datetime) --

        The time the session entered START_IN_PROGRESS state.

      • startedBy (string) --

        The user ID of the user that started the streaming session.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • stopAt (datetime) --

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt (datetime) --

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy (string) --

        The user ID of the user that stopped the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

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

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

DeleteLaunchProfile (updated) Link ¶
Changes (response)
{'launchProfile': {'validationResults': [{'state': 'VALIDATION_NOT_STARTED | '
                                                   'VALIDATION_IN_PROGRESS | '
                                                   'VALIDATION_SUCCESS | '
                                                   'VALIDATION_FAILED | '
                                                   'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusCode': 'VALIDATION_NOT_STARTED '
                                                        '| '
                                                        'VALIDATION_IN_PROGRESS '
                                                        '| VALIDATION_SUCCESS '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_SUBNET_NOT_FOUND '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY '
                                                        '| '
                                                        'VALIDATION_FAILED_UNAUTHORIZED '
                                                        '| '
                                                        'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusMessage': 'string',
                                          'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT '
                                                  '| '
                                                  'VALIDATE_SUBNET_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_NETWORK_ACL_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_SECURITY_GROUP_ASSOCIATION'}]}}

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

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 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',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • launchProfile (dict) --

      The launch profile.

      • arn (string) --

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

            • windows (string) --

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds (list) --

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

          • (string) --

      • 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.

      • validationResults (list) --

        The list of the latest validation results.

        • (dict) --

          The launch profile validation result.

          • state (string) --

            The current state.

          • statusCode (string) --

            The status code. This will contain the failure reason if the state is VALIDATION_FAILED .

          • statusMessage (string) --

            The status message for the validation result.

          • type (string) --

            The type of the validation result.

DeleteStreamingSession (updated) Link ¶
Changes (response)
{'session': {'statusCode': {'AMI_VALIDATION_ERROR'}}}

Deletes streaming session resource.

After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a DELETED state.

A streaming session will count against your streaming session quota until it is marked DELETED.

See also: AWS API Documentation

Request Syntax

client.delete_streaming_session(
    clientToken='string',
    sessionId='string',
    studioId='string'
)
type clientToken

string

param clientToken

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 sessionId

string

param sessionId

[REQUIRED]

The streaming session ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'session': {
        'arn': 'string',
        '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'|'AMI_VALIDATION_ERROR',
        'statusMessage': 'string',
        'stopAt': datetime(2015, 1, 1),
        'stoppedAt': datetime(2015, 1, 1),
        'stoppedBy': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

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. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId (string) --

        The session ID.

      • startedAt (datetime) --

        The time the session entered START_IN_PROGRESS state.

      • startedBy (string) --

        The user ID of the user that started the streaming session.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • stopAt (datetime) --

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt (datetime) --

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy (string) --

        The user ID of the user that stopped the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

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

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

GetLaunchProfile (updated) Link ¶
Changes (response)
{'launchProfile': {'validationResults': [{'state': 'VALIDATION_NOT_STARTED | '
                                                   'VALIDATION_IN_PROGRESS | '
                                                   'VALIDATION_SUCCESS | '
                                                   'VALIDATION_FAILED | '
                                                   'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusCode': 'VALIDATION_NOT_STARTED '
                                                        '| '
                                                        'VALIDATION_IN_PROGRESS '
                                                        '| VALIDATION_SUCCESS '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_SUBNET_NOT_FOUND '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY '
                                                        '| '
                                                        'VALIDATION_FAILED_UNAUTHORIZED '
                                                        '| '
                                                        'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusMessage': 'string',
                                          'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT '
                                                  '| '
                                                  'VALIDATE_SUBNET_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_NETWORK_ACL_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_SECURITY_GROUP_ASSOCIATION'}]}}

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',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • launchProfile (dict) --

      The launch profile.

      • arn (string) --

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

            • windows (string) --

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds (list) --

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

          • (string) --

      • 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.

      • validationResults (list) --

        The list of the latest validation results.

        • (dict) --

          The launch profile validation result.

          • state (string) --

            The current state.

          • statusCode (string) --

            The status code. This will contain the failure reason if the state is VALIDATION_FAILED .

          • statusMessage (string) --

            The status message for the validation result.

          • type (string) --

            The type of the validation result.

GetLaunchProfileDetails (updated) Link ¶
Changes (response)
{'launchProfile': {'validationResults': [{'state': 'VALIDATION_NOT_STARTED | '
                                                   'VALIDATION_IN_PROGRESS | '
                                                   'VALIDATION_SUCCESS | '
                                                   'VALIDATION_FAILED | '
                                                   'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusCode': 'VALIDATION_NOT_STARTED '
                                                        '| '
                                                        'VALIDATION_IN_PROGRESS '
                                                        '| VALIDATION_SUCCESS '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_SUBNET_NOT_FOUND '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY '
                                                        '| '
                                                        'VALIDATION_FAILED_UNAUTHORIZED '
                                                        '| '
                                                        'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusMessage': 'string',
                                          'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT '
                                                  '| '
                                                  'VALIDATE_SUBNET_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_NETWORK_ACL_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_SECURITY_GROUP_ASSOCIATION'}]}}

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',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    },
    'streamingImages': [
        {
            'arn': 'string',
            'description': 'string',
            'ec2ImageId': 'string',
            'encryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'CUSTOMER_MANAGED_KEY'
            },
            'eulaIds': [
                'string',
            ],
            'name': 'string',
            'owner': 'string',
            'platform': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'studioComponentSummaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'name': 'string',
            'studioComponentId': 'string',
            'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
            'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • launchProfile (dict) --

      The launch profile.

      • arn (string) --

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

            • windows (string) --

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds (list) --

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

          • (string) --

      • 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.

      • validationResults (list) --

        The list of the latest validation results.

        • (dict) --

          The launch profile validation result.

          • state (string) --

            The current state.

          • statusCode (string) --

            The status code. This will contain the failure reason if the state is VALIDATION_FAILED .

          • statusMessage (string) --

            The status message for the validation result.

          • type (string) --

            The type of the validation result.

    • streamingImages (list) --

      A collection of streaming images.

      • (dict) --

        Represents a streaming image resource.

        Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.

        Amazon provides a number of streaming images that include popular 3rd-party software.

        You can create your own streaming images using an Amazon 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.

GetStreamingSession (updated) Link ¶
Changes (response)
{'session': {'statusCode': {'AMI_VALIDATION_ERROR'}}}

Gets StreamingSession resource.

Invoke this operation to poll for a streaming session state while creating or deleting a session.

See also: AWS API Documentation

Request Syntax

client.get_streaming_session(
    sessionId='string',
    studioId='string'
)
type sessionId

string

param sessionId

[REQUIRED]

The streaming session ID.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'session': {
        'arn': 'string',
        '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'|'AMI_VALIDATION_ERROR',
        'statusMessage': 'string',
        'stopAt': datetime(2015, 1, 1),
        'stoppedAt': datetime(2015, 1, 1),
        'stoppedBy': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

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. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId (string) --

        The session ID.

      • startedAt (datetime) --

        The time the session entered START_IN_PROGRESS state.

      • startedBy (string) --

        The user ID of the user that started the streaming session.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • stopAt (datetime) --

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt (datetime) --

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy (string) --

        The user ID of the user that stopped the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

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

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

ListLaunchProfiles (updated) Link ¶
Changes (request, response)
Request
{'states': {'CREATE_FAILED',
            'CREATE_IN_PROGRESS',
            'DELETED',
            'DELETE_FAILED',
            'DELETE_IN_PROGRESS',
            'READY',
            'UPDATE_FAILED',
            'UPDATE_IN_PROGRESS'}}
Response
{'launchProfiles': {'validationResults': [{'state': 'VALIDATION_NOT_STARTED | '
                                                    'VALIDATION_IN_PROGRESS | '
                                                    'VALIDATION_SUCCESS | '
                                                    'VALIDATION_FAILED | '
                                                    'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                           'statusCode': 'VALIDATION_NOT_STARTED '
                                                         '| '
                                                         'VALIDATION_IN_PROGRESS '
                                                         '| VALIDATION_SUCCESS '
                                                         '| '
                                                         'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION '
                                                         '| '
                                                         'VALIDATION_FAILED_SUBNET_NOT_FOUND '
                                                         '| '
                                                         'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION '
                                                         '| '
                                                         'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY '
                                                         '| '
                                                         'VALIDATION_FAILED_UNAUTHORIZED '
                                                         '| '
                                                         'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                           'statusMessage': 'string',
                                           'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT '
                                                   '| '
                                                   'VALIDATE_SUBNET_ASSOCIATION '
                                                   '| '
                                                   'VALIDATE_NETWORK_ACL_ASSOCIATION '
                                                   '| '
                                                   'VALIDATE_SECURITY_GROUP_ASSOCIATION'}]}}

List all the launch profiles a studio.

See also: AWS API Documentation

Request Syntax

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

integer

param maxResults

The max number of results to return in the response.

type nextToken

string

param nextToken

The token 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',
            'validationResults': [
                {
                    'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                    'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                    'statusMessage': 'string',
                    'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • launchProfiles (list) --

      A collection of launch profiles.

      • (dict) --

        A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).

        <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.

              • windows (string) --

                The folder path in Windows workstations where files are uploaded.

          • streamingImageIds (list) --

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

            • (string) --

        • 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.

        • validationResults (list) --

          The list of the latest validation results.

          • (dict) --

            The launch profile validation result.

            • state (string) --

              The current state.

            • statusCode (string) --

              The status code. This will contain the failure reason if the state is VALIDATION_FAILED .

            • statusMessage (string) --

              The status message for the validation result.

            • type (string) --

              The type of the validation result.

    • nextToken (string) --

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

ListStreamingSessions (updated) Link ¶
Changes (response)
{'sessions': {'statusCode': {'AMI_VALIDATION_ERROR'}}}

Lists the streaming image resources in a studio.

See also: AWS API Documentation

Request Syntax

client.list_streaming_sessions(
    createdBy='string',
    nextToken='string',
    ownedBy='string',
    sessionIds='string',
    studioId='string'
)
type createdBy

string

param createdBy

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

type nextToken

string

param nextToken

The token to request the next page of results.

type ownedBy

string

param ownedBy

Filters the request to streaming session owned by the given user

type sessionIds

string

param sessionIds

Filters the request to only the provided session IDs.

type studioId

string

param studioId

[REQUIRED]

The studio ID.

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'sessions': [
        {
            'arn': 'string',
            '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'|'AMI_VALIDATION_ERROR',
            'statusMessage': 'string',
            'stopAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'stoppedBy': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            },
            'terminateAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

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. The user that owns the session will be logging into the session and interacting with the virtual workstation.

        • sessionId (string) --

          The session ID.

        • startedAt (datetime) --

          The time the session entered START_IN_PROGRESS state.

        • startedBy (string) --

          The user ID of the user that started the streaming session.

        • state (string) --

          The current state.

        • statusCode (string) --

          The status code.

        • statusMessage (string) --

          The status message for the streaming session.

        • stopAt (datetime) --

          The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

        • stoppedAt (datetime) --

          The time the session entered STOP_IN_PROGRESS state.

        • stoppedBy (string) --

          The user ID of the user that stopped the streaming session.

        • streamingImageId (string) --

          The ID of the streaming image.

        • tags (dict) --

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

          • (string) --

            • (string) --

        • terminateAt (datetime) --

          The time the streaming session will automatically terminate if not terminated by the user.

        • updatedAt (datetime) --

          The Unix epoch timestamp in seconds for when the resource was updated.

        • updatedBy (string) --

          The user ID of the user that most recently updated the resource.

ListStudioComponents (updated) Link ¶
Changes (request)
{'states': {'CREATE_FAILED',
            'CREATE_IN_PROGRESS',
            'DELETED',
            'DELETE_FAILED',
            'DELETE_IN_PROGRESS',
            'READY',
            'UPDATE_FAILED',
            'UPDATE_IN_PROGRESS'},
 'types': {'ACTIVE_DIRECTORY',
           'COMPUTE_FARM',
           'CUSTOM',
           'LICENSE_SERVICE',
           'SHARED_FILE_SYSTEM'}}

Lists the StudioComponents in a studio.

See also: AWS API Documentation

Request Syntax

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

integer

param maxResults

The max number of results to return in the response.

type nextToken

string

param nextToken

The token to request the next page of results.

type states

list

param states

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

  • (string) --

    The current state of the studio component resource.

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

    These are called 'transition states'.

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

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

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

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

type studioId

string

param studioId

[REQUIRED]

The studio ID.

type types

list

param types

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

  • (string) --

rtype

dict

returns

Response Syntax

{
    'nextToken': 'string',
    'studioComponents': [
        {
            'arn': 'string',
            'configuration': {
                'activeDirectoryConfiguration': {
                    'computerAttributes': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'directoryId': 'string',
                    'organizationalUnitDistinguishedName': 'string'
                },
                'computeFarmConfiguration': {
                    'activeDirectoryUser': 'string',
                    'endpoint': 'string'
                },
                'licenseServiceConfiguration': {
                    'endpoint': 'string'
                },
                'sharedFileSystemConfiguration': {
                    'endpoint': 'string',
                    'fileSystemId': 'string',
                    'linuxMountPoint': 'string',
                    'shareName': 'string',
                    'windowsMountDrive': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'ec2SecurityGroupIds': [
                'string',
            ],
            'initializationScripts': [
                {
                    'launchProfileProtocolVersion': 'string',
                    'platform': 'LINUX'|'WINDOWS',
                    'runContext': 'SYSTEM_INITIALIZATION'|'USER_INITIALIZATION',
                    'script': 'string'
                },
            ],
            'name': 'string',
            '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.

          • (string) --

        • initializationScripts (list) --

          Initialization scripts for studio components.

          • (dict) --

            Initialization scripts for studio components.

            • launchProfileProtocolVersion (string) --

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

            • platform (string) --

              The platform of the initialization script, either WINDOWS or LINUX.

            • runContext (string) --

              The method to use when running the initialization script.

            • script (string) --

              The initialization script.

        • name (string) --

          A friendly name for the studio component resource.

        • 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.

          • (string) --

            • (string) --

        • 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.

StartStreamingSession (updated) Link ¶
Changes (response)
{'session': {'statusCode': {'AMI_VALIDATION_ERROR'}}}

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

See also: AWS API Documentation

Request Syntax

client.start_streaming_session(
    clientToken='string',
    sessionId='string',
    studioId='string'
)
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 sessionId

string

param sessionId

[REQUIRED]

The streaming session ID for the StartStreamingSessionRequest.

type studioId

string

param studioId

[REQUIRED]

The studio ID for the StartStreamingSessionRequest.

rtype

dict

returns

Response Syntax

{
    'session': {
        'arn': 'string',
        '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'|'AMI_VALIDATION_ERROR',
        'statusMessage': 'string',
        'stopAt': datetime(2015, 1, 1),
        'stoppedAt': datetime(2015, 1, 1),
        'stoppedBy': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

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. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId (string) --

        The session ID.

      • startedAt (datetime) --

        The time the session entered START_IN_PROGRESS state.

      • startedBy (string) --

        The user ID of the user that started the streaming session.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • stopAt (datetime) --

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt (datetime) --

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy (string) --

        The user ID of the user that stopped the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

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

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

StopStreamingSession (updated) Link ¶
Changes (response)
{'session': {'statusCode': {'AMI_VALIDATION_ERROR'}}}

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

See also: AWS API Documentation

Request Syntax

client.stop_streaming_session(
    clientToken='string',
    sessionId='string',
    studioId='string'
)
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 sessionId

string

param sessionId

[REQUIRED]

The streaming session ID for the StopStreamingSessionRequest.

type studioId

string

param studioId

[REQUIRED]

The studioId for the StopStreamingSessionRequest.

rtype

dict

returns

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'|'AMI_VALIDATION_ERROR',
        'statusMessage': 'string',
        'stopAt': datetime(2015, 1, 1),
        'stoppedAt': datetime(2015, 1, 1),
        'stoppedBy': 'string',
        'streamingImageId': 'string',
        'tags': {
            'string': 'string'
        },
        'terminateAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string'
    }
}

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. The user that owns the session will be logging into the session and interacting with the virtual workstation.

      • sessionId (string) --

        The session ID.

      • startedAt (datetime) --

        The time the session entered START_IN_PROGRESS state.

      • startedBy (string) --

        The user ID of the user that started the streaming session.

      • state (string) --

        The current state.

      • statusCode (string) --

        The status code.

      • statusMessage (string) --

        The status message for the streaming session.

      • stopAt (datetime) --

        The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

      • stoppedAt (datetime) --

        The time the session entered STOP_IN_PROGRESS state.

      • stoppedBy (string) --

        The user ID of the user that stopped the streaming session.

      • streamingImageId (string) --

        The ID of the streaming image.

      • tags (dict) --

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

        • (string) --

          • (string) --

      • terminateAt (datetime) --

        The time the streaming session will automatically terminate if not terminated by the user.

      • updatedAt (datetime) --

        The Unix epoch timestamp in seconds for when the resource was updated.

      • updatedBy (string) --

        The user ID of the user that most recently updated the resource.

UpdateLaunchProfile (updated) Link ¶
Changes (response)
{'launchProfile': {'validationResults': [{'state': 'VALIDATION_NOT_STARTED | '
                                                   'VALIDATION_IN_PROGRESS | '
                                                   'VALIDATION_SUCCESS | '
                                                   'VALIDATION_FAILED | '
                                                   'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusCode': 'VALIDATION_NOT_STARTED '
                                                        '| '
                                                        'VALIDATION_IN_PROGRESS '
                                                        '| VALIDATION_SUCCESS '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_SUBNET_NOT_FOUND '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION '
                                                        '| '
                                                        'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY '
                                                        '| '
                                                        'VALIDATION_FAILED_UNAUTHORIZED '
                                                        '| '
                                                        'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                                          'statusMessage': 'string',
                                          'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT '
                                                  '| '
                                                  'VALIDATE_SUBNET_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_NETWORK_ACL_ASSOCIATION '
                                                  '| '
                                                  'VALIDATE_SECURITY_GROUP_ASSOCIATION'}]}}

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

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 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.

      • windows (string) --

        The folder path in Windows workstations where files are uploaded.

  • streamingImageIds (list) -- [REQUIRED]

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

    • (string) --

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',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • launchProfile (dict) --

      The launch profile.

      • arn (string) --

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

            • windows (string) --

              The folder path in Windows workstations where files are uploaded.

        • streamingImageIds (list) --

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

          • (string) --

      • 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.

      • validationResults (list) --

        The list of the latest validation results.

        • (dict) --

          The launch profile validation result.

          • state (string) --

            The current state.

          • statusCode (string) --

            The status code. This will contain the failure reason if the state is VALIDATION_FAILED .

          • statusMessage (string) --

            The status message for the validation result.

          • type (string) --

            The type of the validation result.