DeadlineCloud / Client / update_storage_profile

update_storage_profile#

DeadlineCloud.Client.update_storage_profile(**kwargs)#

Updates a storage profile.

See also: AWS API Documentation

Request Syntax

response = client.update_storage_profile(
    clientToken='string',
    farmId='string',
    storageProfileId='string',
    displayName='string',
    osFamily='WINDOWS'|'LINUX'|'MACOS',
    fileSystemLocationsToAdd=[
        {
            'name': 'string',
            'path': 'string',
            'type': 'SHARED'|'LOCAL'
        },
    ],
    fileSystemLocationsToRemove=[
        {
            'name': 'string',
            'path': 'string',
            'type': 'SHARED'|'LOCAL'
        },
    ]
)
Parameters:

  • clientToken (string) –

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

  • farmId (string) –

    [REQUIRED]

    The farm ID to update.

  • storageProfileId (string) –

    [REQUIRED]

    The storage profile ID to update.

  • displayName (string) –

    The display name of the storage profile to update.

    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 OS system to update.

  • fileSystemLocationsToAdd (list) –

    The file system location names to add.

    • (dict) –

      The details of the file system location for the resource.

      • name (string) – [REQUIRED]

        The location name.

      • path (string) – [REQUIRED]

        The file path.

      • type (string) – [REQUIRED]

        The type of file.

  • fileSystemLocationsToRemove (list) –

    The file system location names to remove.

    • (dict) –

      The details of the file system location for the resource.

      • name (string) – [REQUIRED]

        The location name.

      • path (string) – [REQUIRED]

        The file path.

      • type (string) – [REQUIRED]

        The type of file.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DeadlineCloud.Client.exceptions.AccessDeniedException

  • DeadlineCloud.Client.exceptions.InternalServerErrorException

  • DeadlineCloud.Client.exceptions.ResourceNotFoundException

  • DeadlineCloud.Client.exceptions.ThrottlingException

  • DeadlineCloud.Client.exceptions.ValidationException