Skip to content

update_storage_profile async

update_storage_profile(
    farm_id: FarmId,
    storage_profile_id: StorageProfileId,
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    display_name: Optional[ResourceName] = None,
    os_family: Optional[StorageProfileOperatingSystemFamily] = None,
    file_system_locations_to_add: Optional[FileSystemLocationsList] = None,
    file_system_locations_to_remove: Optional[FileSystemLocationsList] = None,
) -> UpdateStorageProfileResponse

Updates a storage profile.

Parameters:

  • farm_id (FarmId) –

    The farm ID to update.

  • storage_profile_id (StorageProfileId) –

    The storage profile ID to update.

  • client_token (Optional[ClientToken], default: None ) –

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

  • display_name (Optional[ResourceName], default: None ) –

    The display name of the storage profile to update.

    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.

  • os_family (Optional[StorageProfileOperatingSystemFamily], default: None ) –

    The OS system to update.

  • file_system_locations_to_add (Optional[FileSystemLocationsList], default: None ) –

    The file system location names to add.

  • file_system_locations_to_remove (Optional[FileSystemLocationsList], default: None ) –

    The file system location names to remove.

Raises:

Source code in docs_src/capo_deadline/_services/async_deadline.py
async def update_storage_profile(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    storage_profile_id: "capo_deadline.types.storage_profile_id.StorageProfileId",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
    client_token: Optional["capo_deadline.types.client_token.ClientToken"] = None,
    display_name: Optional["capo_deadline.types.resource_name.ResourceName"] = None,
    os_family: Optional[
        "capo_deadline.types.storage_profile_operating_system_family.StorageProfileOperatingSystemFamily"
    ] = None,
    file_system_locations_to_add: Optional[
        "capo_deadline.types.file_system_locations_list.FileSystemLocationsList"
    ] = None,
    file_system_locations_to_remove: Optional[
        "capo_deadline.types.file_system_locations_list.FileSystemLocationsList"
    ] = None,
) -> "capo_deadline.types.update_storage_profile_response.UpdateStorageProfileResponse":
    """<p>Updates a storage profile.</p>

    Args:
        farm_id: <p>The farm ID to update.</p>
        storage_profile_id: <p>The storage profile ID to update.</p>
        client_token: <p>The unique token which the server uses to recognize retries of the same request.</p>
        display_name: <p>The display name of the storage profile to update.</p> <important> <p>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.</p> </important>
        os_family: <p>The OS system to update.</p>
        file_system_locations_to_add: <p>The file system location names to add.</p>
        file_system_locations_to_remove: <p>The file system location names to remove.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_deadline.types.update_storage_profile_request.UpdateStorageProfileRequest]",
    ) -> AsyncOperationResponse[
        "capo_deadline.types.update_storage_profile_response.UpdateStorageProfileResponse"
    ]:
        import capo_deadline._operations.deadline.update_storage_profile

        (
            output,
            http_response,
        ) = await capo_deadline._operations.deadline.update_storage_profile.async_update_storage_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_deadline.types.update_storage_profile_request.UpdateStorageProfileRequest",
    ) -> dict[str, Any]:
        import capo_deadline.types.update_storage_profile_request

        return capo_deadline.types.update_storage_profile_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateStorageProfile", redact_input=_redact_input),
    )
    input_: capo_deadline.types.update_storage_profile_request.UpdateStorageProfileRequest = {
        "farm_id": farm_id,
        "storage_profile_id": storage_profile_id,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if display_name is not None:
        input_["display_name"] = display_name
    if os_family is not None:
        input_["os_family"] = os_family
    if file_system_locations_to_add is not None:
        input_["file_system_locations_to_add"] = file_system_locations_to_add
    if file_system_locations_to_remove is not None:
        input_["file_system_locations_to_remove"] = file_system_locations_to_remove

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output