DeadlineCloud / Client / get_storage_profile

get_storage_profile#

DeadlineCloud.Client.get_storage_profile(**kwargs)#

Gets a storage profile.

See also: AWS API Documentation

Request Syntax

response = client.get_storage_profile(
    farmId='string',
    storageProfileId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID for the storage profile.

  • storageProfileId (string) –

    [REQUIRED]

    The storage profile ID.

Return type:

dict

Returns:

Response Syntax

{
    'storageProfileId': 'string',
    'displayName': 'string',
    'osFamily': 'WINDOWS'|'LINUX'|'MACOS',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    '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.

      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 (OS) for the storage profile.

    • createdAt (datetime) –

      The date and time the resource was created.

    • createdBy (string) –

      The user or system that created this resource.

    • updatedAt (datetime) –

      The date and time the resource was updated.

    • updatedBy (string) –

      The user or system that updated this resource.

    • fileSystemLocations (list) –

      The location of the files for the storage profile.

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