NimbleStudio / Client / get_launch_profile_details

get_launch_profile_details#

NimbleStudio.Client.get_launch_profile_details(**kwargs)#

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.

Request Syntax

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

Parameters:

launchProfileId (string) –
[REQUIRED]

The ID of the launch profile used to control access from the streaming session.
studioId (string) –
[REQUIRED]

The studio ID.

Return type:

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'|'INVALID_INSTANCE_TYPES_PROVIDED'|'INVALID_SUBNETS_COMBINATION',
        'statusMessage': 'string',
        'streamConfiguration': {
            'automaticTerminationMode': 'DEACTIVATED'|'ACTIVATED',
            'clipboardMode': 'ENABLED'|'DISABLED',
            'ec2InstanceTypes': [
                'g4dn.xlarge'|'g4dn.2xlarge'|'g4dn.4xlarge'|'g4dn.8xlarge'|'g4dn.12xlarge'|'g4dn.16xlarge'|'g3.4xlarge'|'g3s.xlarge'|'g5.xlarge'|'g5.2xlarge'|'g5.4xlarge'|'g5.8xlarge'|'g5.16xlarge',
            ],
            'maxSessionLengthInMinutes': 123,
            'maxStoppedSessionLengthInMinutes': 123,
            'sessionBackup': {
                'maxBackupsToRetain': 123,
                'mode': 'AUTOMATIC'|'DEACTIVATED'
            },
            'sessionPersistenceMode': 'DEACTIVATED'|'ACTIVATED',
            'sessionStorage': {
                'mode': [
                    'UPLOAD',
                ],
                'root': {
                    'linux': 'string',
                    'windows': 'string'
                }
            },
            'streamingImageIds': [
                'string',
            ],
            'volumeConfiguration': {
                'iops': 123,
                'size': 123,
                'throughput': 123
            }
        },
        'studioComponentIds': [
            'string',
        ],
        'tags': {
            'string': 'string'
        },
        'updatedAt': datetime(2015, 1, 1),
        'updatedBy': 'string',
        'validationResults': [
            {
                'state': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusCode': 'VALIDATION_NOT_STARTED'|'VALIDATION_IN_PROGRESS'|'VALIDATION_SUCCESS'|'VALIDATION_FAILED_INVALID_SUBNET_ROUTE_TABLE_ASSOCIATION'|'VALIDATION_FAILED_SUBNET_NOT_FOUND'|'VALIDATION_FAILED_INVALID_SECURITY_GROUP_ASSOCIATION'|'VALIDATION_FAILED_INVALID_ACTIVE_DIRECTORY'|'VALIDATION_FAILED_UNAUTHORIZED'|'VALIDATION_FAILED_INTERNAL_SERVER_ERROR',
                'statusMessage': 'string',
                'type': 'VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT'|'VALIDATE_SUBNET_ASSOCIATION'|'VALIDATE_NETWORK_ACL_ASSOCIATION'|'VALIDATE_SECURITY_GROUP_ASSOCIATION'
            },
        ]
    },
    'streamingImages': [
        {
            'arn': 'string',
            'description': 'string',
            'ec2ImageId': 'string',
            'encryptionConfiguration': {
                'keyArn': 'string',
                'keyType': 'CUSTOMER_MANAGED_KEY'
            },
            'eulaIds': [
                'string',
            ],
            'name': 'string',
            'owner': 'string',
            'platform': 'string',
            'state': 'CREATE_IN_PROGRESS'|'READY'|'DELETE_IN_PROGRESS'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'CREATE_FAILED'|'DELETE_FAILED',
            'statusCode': 'STREAMING_IMAGE_CREATE_IN_PROGRESS'|'STREAMING_IMAGE_READY'|'STREAMING_IMAGE_DELETE_IN_PROGRESS'|'STREAMING_IMAGE_DELETED'|'STREAMING_IMAGE_UPDATE_IN_PROGRESS'|'INTERNAL_ERROR'|'ACCESS_DENIED',
            'statusMessage': 'string',
            'streamingImageId': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'studioComponentSummaries': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'name': 'string',
            'studioComponentId': 'string',
            'subtype': 'AWS_MANAGED_MICROSOFT_AD'|'AMAZON_FSX_FOR_WINDOWS'|'AMAZON_FSX_FOR_LUSTRE'|'CUSTOM',
            'type': 'ACTIVE_DIRECTORY'|'SHARED_FILE_SYSTEM'|'COMPUTE_FARM'|'LICENSE_SERVICE'|'CUSTOM',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ]
}

Response Structure

(dict) –
- launchProfile (dict) –
  
  The launch profile.
  - arn (string) –
    
    The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
  - createdAt (datetime) –
    
    The ISO timestamp in seconds for when the resource was created.
  - createdBy (string) –
    
    The user ID of the user that created the launch profile.
  - description (string) –
    
    A human-readable description of the launch profile.
  - ec2SubnetIds (list) –
    
    Unique identifiers for a collection of EC2 subnets.
    - (string) –
  - launchProfileId (string) –
    
    The ID of the launch profile used to control access from the streaming session.
  - launchProfileProtocolVersions (list) –
    
    The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.
    - (string) –
      
      The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.
  - name (string) –
    
    A friendly name for the launch profile.
  - state (string) –
    
    The current state.
  - statusCode (string) –
    
    The status code.
  - statusMessage (string) –
    
    The status message for the launch profile.
  - streamConfiguration (dict) –
    
    A configuration for a streaming session.
    - automaticTerminationMode (string) –
      
      Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.
      - When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.
      - When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.
      This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.
    - clipboardMode (string) –
      
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
    - ec2InstanceTypes (list) –
      
      The EC2 instance types that users can select from when launching a streaming session with this launch profile.
      - (string) –
    - maxSessionLengthInMinutes (integer) –
      
      The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
    - maxStoppedSessionLengthInMinutes (integer) –
      
      Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
      
      This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED.
      
      If the value is set to 0, your sessions can’t be STOPPED. If you then call StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be terminated (instead of STOPPED).
      
      If the value is set to a positive number, the session can be stopped. You can call StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).
    - sessionBackup (dict) –
      
      Information about the streaming session backup.
      - maxBackupsToRetain (integer) –
        
        The maximum number of backups that each streaming session created from this launch profile can have.
      - mode (string) –
        
        Specifies how artists sessions are backed up.
        
        Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED, which means that backups are deactivated. To allow backups, set this value to AUTOMATIC.
    - sessionPersistenceMode (string) –
      
      Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
    - sessionStorage (dict) –
      
      The upload storage for a streaming session.
      - mode (list) –
        
        Allows artists to upload files to their workstations. The only valid option is UPLOAD.
        
        (string) –
      - root (dict) –
        
        The configuration for the upload storage root of the streaming session.
        
        linux (string) –
        
        The folder path in Linux workstations where files are uploaded.
        
        windows (string) –
        
        The folder path in Windows workstations where files are uploaded.
    - streamingImageIds (list) –
      
      The streaming images that users can select from when launching a streaming session with this launch profile.
      - (string) –
    - volumeConfiguration (dict) –
      
      Custom volume configuration for the root volumes that are attached to streaming sessions.
      
      This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
      - iops (integer) –
        
        The number of I/O operations per second for the root volume that is attached to streaming session.
      - size (integer) –
        
        The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.
      - throughput (integer) –
        
        The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.
  - studioComponentIds (list) –
    
    Unique identifiers for a collection of studio components that can be used with this launch profile.
    - (string) –
  - tags (dict) –
    
    A collection of labels, in the form of key-value pairs, that apply to this resource.
    - (string) –
      - (string) –
  - updatedAt (datetime) –
    
    The ISO timestamp in seconds for when the resource was updated.
  - updatedBy (string) –
    
    The user ID of the user that most recently updated the resource.
  - validationResults (list) –
    
    The list of the latest validation results.
    - (dict) –
      
      The launch profile validation result.
      - state (string) –
        
        The current state.
      - statusCode (string) –
        
        The status code. This will contain the failure reason if the state is VALIDATION_FAILED.
      - statusMessage (string) –
        
        The status message for the validation result.
      - type (string) –
        
        The type of the validation result.
- streamingImages (list) –
  
  A collection of streaming images.
  - (dict) –
    
    Represents a streaming image resource.
    
    Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
    
    Amazon provides a number of streaming images that include popular 3rd-party software.
    
    You can create your own streaming images using an Amazon EC2 machine image that you create for this purpose. You can also include software that your users require.
    - arn (string) –
      
      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
    - description (string) –
      
      A human-readable description of the streaming image.
    - ec2ImageId (string) –
      
      The ID of an EC2 machine image with which to create the streaming image.
    - encryptionConfiguration (dict) –
      
      The encryption configuration.
      - keyArn (string) –
        
        The ARN for a KMS key that is used to encrypt studio data.
      - keyType (string) –
        
        The type of KMS key that is used to encrypt studio data.
    - eulaIds (list) –
      
      The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.
      - (string) –
    - name (string) –
      
      A friendly name for a streaming image resource.
    - owner (string) –
      
      The owner of the streaming image, either the studioId that contains the streaming image, or amazon for images that are provided by Amazon Nimble Studio.
    - platform (string) –
      
      The platform of the streaming image, either Windows or Linux.
    - state (string) –
      
      The current state.
    - statusCode (string) –
      
      The status code.
    - statusMessage (string) –
      
      The status message for the streaming image.
    - streamingImageId (string) –
      
      The ID of the streaming image.
    - tags (dict) –
      
      A collection of labels, in the form of key-value pairs, that apply to this resource.
      - (string) –
        
        (string) –
- studioComponentSummaries (list) –
  
  A collection of studio component summaries.
  - (dict) –
    
    The studio component’s summary.
    - createdAt (datetime) –
      
      The ISO timestamp in seconds for when the resource was created.
    - createdBy (string) –
      
      The user ID of the user that created the studio component.
    - description (string) –
      
      The description.
    - name (string) –
      
      The name for the studio component.
    - studioComponentId (string) –
      
      The unique identifier for a studio component resource.
    - subtype (string) –
      
      The specific subtype of a studio component.
    - type (string) –
      
      The type of the studio component.
    - updatedAt (datetime) –
      
      The ISO timestamp in seconds for when the resource was updated.
    - updatedBy (string) –
      
      The user ID of the user that most recently updated the resource.

Exceptions

NimbleStudio.Client.exceptions.ResourceNotFoundException
NimbleStudio.Client.exceptions.ConflictException
NimbleStudio.Client.exceptions.ThrottlingException
NimbleStudio.Client.exceptions.ValidationException
NimbleStudio.Client.exceptions.AccessDeniedException
NimbleStudio.Client.exceptions.InternalServerErrorException
NimbleStudio.Client.exceptions.ServiceQuotaExceededException