DeadlineCloud / Client / get_storage_profile_for_queue

get_storage_profile_for_queue#

DeadlineCloud.Client.get_storage_profile_for_queue(**kwargs)#

Gets a storage profile for a queue.

Request Syntax

response = client.get_storage_profile_for_queue(
    farmId='string',
    queueId='string',
    storageProfileId='string'
)

Parameters:

farmId (string) –
[REQUIRED]

The farm ID for the queue in storage profile.
queueId (string) –
[REQUIRED]

The queue ID the queue in the storage profile.
storageProfileId (string) –
[REQUIRED]

The storage profile ID for the storage profile in the queue.

Return type:

dict

Returns:

Response Syntax

{
    'storageProfileId': 'string',
    'displayName': 'string',
    'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
    'fileSystemLocations': [
        {
            'name': 'string',
            'path': 'string',
            'type': 'SHARED'|'LOCAL'
        },
    ]
}

Response Structure

(dict) –
- storageProfileId (string) –
  
  The storage profile ID.
- displayName (string) –
  
  The display name of the storage profile connected to a queue.
  
  Warning
  This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
- osFamily (string) –
  
  The operating system of the storage profile in the queue.
- fileSystemLocations (list) –
  
  The location of the files for the storage profile within the queue.
  - (dict) –
    
    The details of the file system location for the resource.
    - name (string) –
      
      The location name.
    - path (string) –
      
      The file path.
    - type (string) –
      
      The type of file.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException