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.

See also: AWS API Documentation

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

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

Response Structure

  • (dict) –

    • displayName (string) –

      The display name of the storage profile connected to a 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.

    • osFamily (string) –

      The operating system of the storage profile in the queue.

    • storageProfileId (string) –

      The storage profile ID.

Exceptions